Module org.autogui

Package org.autogui.swing.icons

Class GuiSwingIcons

java.lang.Object

org.autogui.swing.icons.GuiSwingIcons

public class GuiSwingIcons
extends Object

an Icon factory

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GuiSwingIcons.ActionButton	an action button with the customized border
static class	GuiSwingIcons.ResourceIcon	an Icon with an Image and size

Field Summary

Fields

Modifier and Type	Field	Description
protected Icon	defaultIcon
protected Map<String,Icon>	iconMap
protected List<String>	iconWords
protected static GuiSwingIcons	instance
static String	PRESSED_ICON_KEY
protected Map<String,Icon>	pressedIconMap
protected String	suffix
protected Map<String,String>	synonyms

Constructor Summary

Constructors

Constructor	Description
GuiSwingIcons()

Method Summary

Modifier and Type	Method	Description
void	addIconWords(String... names)
void	addSynonym(String name, String... synonyms)
Icon	getAcceptIcon()
Icon	getAddIcon()
Icon	getAdjustIcon()
Icon	getApplyIcon()
Icon	getBindIcon()
Icon	getBuildIcon()
Icon	getCalculateIcon()
Icon	getCallIcon()
Icon	getChangeIcon()
Icon	getCheckIcon()
Icon	getClearIcon()
Icon	getCloseIcon()
Icon	getCollectIcon()
Icon	getCommitIcon()
Icon	getCompareIcon()
Icon	getCompleteIcon()
Icon	getComposeIcon()
Icon	getConfigureIcon()
Icon	getConnectIcon()
Icon	getConvertIcon()
Icon	getCopyIcon()
Icon	getCountIcon()
Icon	getCreateIcon()
Icon	getDeactivateIcon()
Icon	getDecodeIcon()
Icon	getDefaultIcon(String name)
Icon	getDefineIcon()
Icon	getDeleteIcon()
Icon	getDeriveIcon()
Icon	getDivideIcon()
Icon	getDownIcon()
Icon	getDrawIcon()
Icon	getEncodeIcon()
Icon	getEnsureIcon()
Icon	getExportIcon()
Icon	getExtractIcon()
Icon	getFillIcon()
Icon	getFindIcon()
Icon	getFocusIcon()
Icon	getGetIcon()
Icon	getHandleIcon()
Icon	getHelpIcon()
Icon	getHideIcon()
Icon	getIcon(String name)
Icon	getIcon(String prefix, String name, int width, int height)
Map<String,Icon>	getIconMap()
List<String>	getIconWords()
static GuiSwingIcons	getInstance()
Icon	getListIcon()
Icon	getLoadIcon()
Icon	getLockIcon()
Icon	getMapIcon()
Icon	getMarkIcon()
Icon	getMergeIcon()
Icon	getMinusIcon()
Icon	getMoveIcon()
Icon	getMultiplyIcon()
Icon	getNegateIcon()
Icon	getNextIcon()
Icon	getNormalizeIcon()
Icon	getNotifyIcon()
Icon	getPaintIcon()
Icon	getPeekIcon()
Icon	getPlusIcon()
Icon	getPressedIcon(String name)	returns a gray version of the icon obtained by getIcon(name).
Icon	getPressedIcon(String prefix, String name, int width, int height)
Map<String,Icon>	getPressedIconMap()
Icon	getPreviousIcon()
Icon	getPrintIcon()
Icon	getProvideIcon()
Icon	getPublishIcon()
Icon	getPutIcon()
Icon	getReadIcon()
Icon	getReceiveIcon()
Icon	getReduceIcon()
Icon	getRegisterIcon()
Icon	getReleaseIcon()
Icon	getRemoveIcon()
Icon	getRenameIcon()
Icon	getReplaceIcon()
Icon	getRequestIcon()
Icon	getResizeIcon()
Icon	getResolveIcon()
Icon	getRetainIcon()
Icon	getReverseIcon()
Icon	getRotateIcon()
Icon	getSaveIcon()
Icon	getScheduleIcon()
Icon	getScrollIcon()
Icon	getSelectIcon()
Icon	getSetIcon()
Icon	getShiftIcon()
Icon	getShowIcon()
Icon	getSkipIcon()
Icon	getSliceIcon()
Icon	getSortIcon()
Icon	getSplitIcon()
Icon	getStartIcon()
Icon	getStopIcon()
Icon	getSyncIcon()
Map<String,String>	getSynonyms()
Icon	getTrimIcon()
Icon	getTryIcon()
Icon	getUndoIcon()
Icon	getUnlockIcon()
Icon	getUnregisterIcon()
Icon	getUnwrapIcon()
Icon	getUpdateIcon()
Icon	getUpIcon()
Icon	getUseIcon()
Icon	getWaitIcon()
Icon	getWrapIcon()
Icon	getWriteIcon()
void	initSynonyms()
Icon	loadIcon(String name)
Icon	loadIcon(String prefix, String name, String suffix, int width, int height)
Icon	loadIconOrDefault(String name)
Icon	loadPressedIcon(String name)
Icon	loadPressedIcon(Icon icon)
GuiSwingIcons	putIcon(String prefix, String name, Icon icon)	manually sets the icon for the name
GuiSwingIcons	putIconAction(String name, Icon icon)	manually sets the icon for "action-" + name

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

instance

protected static GuiSwingIcons instance

iconMap

protected Map<String,Icon> iconMap

pressedIconMap

protected Map<String,Icon> pressedIconMap

iconWords

protected List<String> iconWords

synonyms

protected Map<String,String> synonyms

defaultIcon

protected Icon defaultIcon

suffix

protected String suffix

PRESSED_ICON_KEY

public static String PRESSED_ICON_KEY

Constructor Details

GuiSwingIcons

public GuiSwingIcons()

Method Details

getInstance

public static GuiSwingIcons getInstance()

putIcon

public GuiSwingIcons putIcon(String prefix,
 String name,
 Icon icon)

manually sets the icon for the name

Parameters:

prefix - a prefix of the name

name - the name of the icon

icon - the icon instance

Returns:

this

Since:

1.2

putIconAction

public GuiSwingIcons putIconAction(String name,
 Icon icon)

manually sets the icon for "action-" + name

Parameters:

name - the name of the icon

icon - the icon instance

Returns:

this

Since:

1.2

getIcon

public Icon getIcon(String name)

getIcon

public Icon getIcon(String prefix,
 String name,
 int width,
 int height)

loadIconOrDefault

public Icon loadIconOrDefault(String name)

loadIcon

public Icon loadIcon(String name)

loadIcon

public Icon loadIcon(String prefix,
 String name,
 String suffix,
 int width,
 int height)

getDefaultIcon

public Icon getDefaultIcon(String name)

addSynonym

public void addSynonym(String name,
 String... synonyms)

addIconWords

public void addIconWords(String... names)

getIconWords

public List<String> getIconWords()

getIconMap

public Map<String,Icon> getIconMap()

Returns:

loaded icon entries. initially, empty

getPressedIconMap

public Map<String,Icon> getPressedIconMap()

getSynonyms

public Map<String,String> getSynonyms()

getPressedIcon

public Icon getPressedIcon(String name)

returns a gray version of the icon obtained by getIcon(name). this can be set for the pressed icon of a button:

     button.setPressedIcon(icons.getPressedIcon(name));
 

Default impl. of some UI automatically generates the pressed icon for an ImageIcon, but does not for another icon type.

Parameters:

name - the action icon name

Returns:

the pressed icon for the name

loadPressedIcon

public Icon loadPressedIcon(String name)

loadPressedIcon

public Icon loadPressedIcon(Icon icon)

getPressedIcon

public Icon getPressedIcon(String prefix,
 String name,
 int width,
 int height)

getAcceptIcon

public Icon getAcceptIcon()

getAddIcon

public Icon getAddIcon()

getAdjustIcon

public Icon getAdjustIcon()

getApplyIcon

public Icon getApplyIcon()

getBindIcon

public Icon getBindIcon()

getBuildIcon

public Icon getBuildIcon()

getCalculateIcon

public Icon getCalculateIcon()

getCallIcon

public Icon getCallIcon()

getChangeIcon

public Icon getChangeIcon()

getCheckIcon

public Icon getCheckIcon()

getClearIcon

public Icon getClearIcon()

getCloseIcon

public Icon getCloseIcon()

getCollectIcon

public Icon getCollectIcon()

getCommitIcon

public Icon getCommitIcon()

getCompareIcon

public Icon getCompareIcon()

getCompleteIcon

public Icon getCompleteIcon()

getComposeIcon

public Icon getComposeIcon()

getConfigureIcon

public Icon getConfigureIcon()

getConnectIcon

public Icon getConnectIcon()

getConvertIcon

public Icon getConvertIcon()

getCopyIcon

public Icon getCopyIcon()

getCountIcon

public Icon getCountIcon()

getCreateIcon

public Icon getCreateIcon()

getDeactivateIcon

public Icon getDeactivateIcon()

getDecodeIcon

public Icon getDecodeIcon()

getDefineIcon

public Icon getDefineIcon()

getDeleteIcon

public Icon getDeleteIcon()

getDeriveIcon

public Icon getDeriveIcon()

getDivideIcon

public Icon getDivideIcon()

getDownIcon

public Icon getDownIcon()

getDrawIcon

public Icon getDrawIcon()

getEncodeIcon

public Icon getEncodeIcon()

getEnsureIcon

public Icon getEnsureIcon()

getExportIcon

public Icon getExportIcon()

getExtractIcon

public Icon getExtractIcon()

getFillIcon

public Icon getFillIcon()

getFindIcon

public Icon getFindIcon()

getFocusIcon

public Icon getFocusIcon()

getGetIcon

public Icon getGetIcon()

getHandleIcon

public Icon getHandleIcon()

getHelpIcon

public Icon getHelpIcon()

getHideIcon

public Icon getHideIcon()

getListIcon

public Icon getListIcon()

getLoadIcon

public Icon getLoadIcon()

getLockIcon

public Icon getLockIcon()

getMapIcon

public Icon getMapIcon()

getMarkIcon

public Icon getMarkIcon()

getMergeIcon

public Icon getMergeIcon()

getMinusIcon

public Icon getMinusIcon()

getMoveIcon

public Icon getMoveIcon()

getMultiplyIcon

public Icon getMultiplyIcon()

getNegateIcon

public Icon getNegateIcon()

getNextIcon

public Icon getNextIcon()

getNormalizeIcon

public Icon getNormalizeIcon()

getNotifyIcon

public Icon getNotifyIcon()

getPaintIcon

public Icon getPaintIcon()

getPeekIcon

public Icon getPeekIcon()

getPlusIcon

public Icon getPlusIcon()

getPreviousIcon

public Icon getPreviousIcon()

getPrintIcon

public Icon getPrintIcon()

getProvideIcon

public Icon getProvideIcon()

getPublishIcon

public Icon getPublishIcon()

getPutIcon

public Icon getPutIcon()

getReadIcon

public Icon getReadIcon()

getReceiveIcon

public Icon getReceiveIcon()

getReduceIcon

public Icon getReduceIcon()

getRegisterIcon

public Icon getRegisterIcon()

getReleaseIcon

public Icon getReleaseIcon()

getRemoveIcon

public Icon getRemoveIcon()

getRenameIcon

public Icon getRenameIcon()

getReplaceIcon

public Icon getReplaceIcon()

getRequestIcon

public Icon getRequestIcon()

getResizeIcon

public Icon getResizeIcon()

getResolveIcon

public Icon getResolveIcon()

getRetainIcon

public Icon getRetainIcon()

getReverseIcon

public Icon getReverseIcon()

getRotateIcon

public Icon getRotateIcon()

getSaveIcon

public Icon getSaveIcon()

getScheduleIcon

public Icon getScheduleIcon()

getScrollIcon

public Icon getScrollIcon()

getSelectIcon

public Icon getSelectIcon()

getSetIcon

public Icon getSetIcon()

getShiftIcon

public Icon getShiftIcon()

getShowIcon

public Icon getShowIcon()

getSkipIcon

public Icon getSkipIcon()

getSliceIcon

public Icon getSliceIcon()

getSortIcon

public Icon getSortIcon()

getSplitIcon

public Icon getSplitIcon()

getStartIcon

public Icon getStartIcon()

getStopIcon

public Icon getStopIcon()

getSyncIcon

public Icon getSyncIcon()

getTrimIcon

public Icon getTrimIcon()

getTryIcon

public Icon getTryIcon()

getUndoIcon

public Icon getUndoIcon()

getUnlockIcon

public Icon getUnlockIcon()

getUnregisterIcon

public Icon getUnregisterIcon()

getUnwrapIcon

public Icon getUnwrapIcon()

getUpIcon

public Icon getUpIcon()

getUpdateIcon

public Icon getUpdateIcon()

getUseIcon

public Icon getUseIcon()

getWaitIcon

public Icon getWaitIcon()

getWrapIcon

public Icon getWrapIcon()

getWriteIcon

public Icon getWriteIcon()

initSynonyms

public void initSynonyms()