net.sf.gridarta.utils

Class SystemIcons

java.lang.Object

net.sf.gridarta.utils.SystemIcons

public class SystemIcons
extends Object

Utility class for system icons.

Author:

Andreas Kirschbaum

Field Summary

Fields

Modifier and Type	Field and Description
private static String	APP_ICON Application icon definitions (icon-dir).
private ImageIcon	appIcon The application's icon or null if none is available.
private static String	AUTO_RUN_SMALL_ICON
private Icon	autoRunSmallIcon
private static String	CLOSE_TAB_SMALL_ICON
private ImageIcon	closeTabSmallIcon
static String	DEFAULT_ICON The default map icon to use if no icon can be created.
static String	DEFAULT_PREVIEW The default map preview to use if no icon can be created.
private Image	defaultIcon The default icon Image for map previews.
private Image	defaultPreview The default preview Image for map icon.
private Icon	emptySquareIcon
private static String	FILTER_SMALL_ICON
private Icon	filterSmallIcon
private GUIUtils	guiUtils The GUIUtils for creating icons.
private static String	ICON_DIR The directory that contains the common-use icons.
private ImageIcon	lightSquareIcon
private ImageIcon	mapCursorIcon
private ImageIcon	mapPreSelIcon
private ImageIcon	mapSelIcon
private ImageIcon	mapSelIconEast
private ImageIcon	mapSelIconNorth
private ImageIcon	mapSelIconSouth
private ImageIcon	mapSelIconWest
private ImageIcon	noArchSquareIcon
private ImageIcon	noFaceSquareIcon
private static String	RUN_PLUGIN_SMALL_ICON
private Icon	runPluginSmallIcon
static String	SQUARE_CURSOR
static String	SQUARE_EMPTY
static String	SQUARE_LIGHT The name of the image for highlighting map squares that are affected by nearby light emitting game objects.
static String	SQUARE_NO_ARCH
static String	SQUARE_NO_FACE
static String	SQUARE_PRE_SELECTED_SQUARE
static String	SQUARE_SELECTED_SQUARE
static String	SQUARE_SELECTED_SQUARE_EAST
static String	SQUARE_SELECTED_SQUARE_NORTH
static String	SQUARE_SELECTED_SQUARE_SOUTH
static String	SQUARE_SELECTED_SQUARE_WEST
static String	SQUARE_UNKNOWN
static String	SQUARE_WARNING
static String	SYSTEM_DIR The directory that contains the system icons.
private static String	TREASURE_LIST
private static String	TREASURE_NO
private static String	TREASURE_YES
private Icon	treasureListIcon
private Icon	treasureNoIcon
private static String	TREASUREONE_LIST
private Icon	treasureOneListIcon
private Icon	treasureYesIcon
private ImageIcon	unknownSquareIcon
private ImageIcon	warningSquareIcon

Constructor Summary

Constructors

Constructor and Description
SystemIcons(GUIUtils guiUtils) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
ImageIcon	getAppIcon() Returns the application's icon.
Icon	getAutoRunSmallIcon()
ImageIcon	getCloseTabSmallIcon()
Image	getDefaultIcon() Returns the default icon Image for map previews.
Image	getDefaultPreview() Returns the default preview Image for map icon.
Icon	getEmptySquareIcon()
Icon	getFilterSmallIcon()
ImageIcon	getLightSquareIcon() Returns the ImageIcon for highlighting map squares that are affected by nearby light emitting game objects.
ImageIcon	getMapCursorIcon()
ImageIcon	getMapPreSelectedIcon()
ImageIcon	getMapSelectedIcon()
ImageIcon	getMapSelectedIconEast()
ImageIcon	getMapSelectedIconNorth()
ImageIcon	getMapSelectedIconSouth()
ImageIcon	getMapSelectedIconWest()
ImageIcon	getNoArchSquareIcon()
ImageIcon	getNoFaceSquareIcon()
Icon	getRunPluginSmallIcon()
Icon	getTreasureListIcon()
Icon	getTreasureNoIcon()
Icon	getTreasureOneListIcon()
Icon	getTreasureYesIcon()
ImageIcon	getUnknownSquareIcon()
ImageIcon	getWarningSquareIcon()

Methods inherited from class java.lang.Object

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

Field Detail

ICON_DIR

private static final String ICON_DIR

The directory that contains the common-use icons.

See Also:

Constant Field Values

SYSTEM_DIR

public static final String SYSTEM_DIR

The directory that contains the system icons.

See Also:

Constant Field Values

SQUARE_SELECTED_SQUARE

public static final String SQUARE_SELECTED_SQUARE

See Also:

Constant Field Values

SQUARE_SELECTED_SQUARE_NORTH

public static final String SQUARE_SELECTED_SQUARE_NORTH

See Also:

Constant Field Values

SQUARE_SELECTED_SQUARE_EAST

public static final String SQUARE_SELECTED_SQUARE_EAST

See Also:

Constant Field Values

SQUARE_SELECTED_SQUARE_SOUTH

public static final String SQUARE_SELECTED_SQUARE_SOUTH

See Also:

Constant Field Values

SQUARE_SELECTED_SQUARE_WEST

public static final String SQUARE_SELECTED_SQUARE_WEST

See Also:

Constant Field Values

SQUARE_PRE_SELECTED_SQUARE

public static final String SQUARE_PRE_SELECTED_SQUARE

See Also:

Constant Field Values

SQUARE_CURSOR

public static final String SQUARE_CURSOR

See Also:

Constant Field Values

SQUARE_EMPTY

public static final String SQUARE_EMPTY

See Also:

Constant Field Values

SQUARE_UNKNOWN

public static final String SQUARE_UNKNOWN

See Also:

Constant Field Values

SQUARE_WARNING

public static final String SQUARE_WARNING

See Also:

Constant Field Values

SQUARE_LIGHT

public static final String SQUARE_LIGHT

The name of the image for highlighting map squares that are affected by nearby light emitting game objects.

See Also:

Constant Field Values

SQUARE_NO_FACE

public static final String SQUARE_NO_FACE

See Also:

Constant Field Values

SQUARE_NO_ARCH

public static final String SQUARE_NO_ARCH

See Also:

Constant Field Values

TREASURE_LIST

private static final String TREASURE_LIST

See Also:

Constant Field Values

TREASUREONE_LIST

private static final String TREASUREONE_LIST

See Also:

Constant Field Values

TREASURE_YES

private static final String TREASURE_YES

See Also:

Constant Field Values

TREASURE_NO

private static final String TREASURE_NO

See Also:

Constant Field Values

DEFAULT_ICON

public static final String DEFAULT_ICON

The default map icon to use if no icon can be created.

See Also:

Constant Field Values

DEFAULT_PREVIEW

public static final String DEFAULT_PREVIEW

The default map preview to use if no icon can be created.

See Also:

Constant Field Values

CLOSE_TAB_SMALL_ICON

private static final String CLOSE_TAB_SMALL_ICON

See Also:

Constant Field Values

AUTO_RUN_SMALL_ICON

private static final String AUTO_RUN_SMALL_ICON

See Also:

Constant Field Values

FILTER_SMALL_ICON

private static final String FILTER_SMALL_ICON

See Also:

Constant Field Values

RUN_PLUGIN_SMALL_ICON

private static final String RUN_PLUGIN_SMALL_ICON

See Also:

Constant Field Values

APP_ICON

private static final String APP_ICON

Application icon definitions (icon-dir).

See Also:

Constant Field Values

guiUtils

@NotNull
private final GUIUtils guiUtils

The GUIUtils for creating icons.

mapSelIcon

@Nullable
private ImageIcon mapSelIcon

mapSelIconNorth

@Nullable
private ImageIcon mapSelIconNorth

mapSelIconEast

@Nullable
private ImageIcon mapSelIconEast

mapSelIconSouth

@Nullable
private ImageIcon mapSelIconSouth

mapSelIconWest

@Nullable
private ImageIcon mapSelIconWest

mapPreSelIcon

@Nullable
private ImageIcon mapPreSelIcon

mapCursorIcon

@Nullable
private ImageIcon mapCursorIcon

emptySquareIcon

@Nullable
private Icon emptySquareIcon

unknownSquareIcon

@Nullable
private ImageIcon unknownSquareIcon

warningSquareIcon

@Nullable
private ImageIcon warningSquareIcon

lightSquareIcon

@Nullable
private ImageIcon lightSquareIcon

noFaceSquareIcon

@Nullable
private ImageIcon noFaceSquareIcon

noArchSquareIcon

@Nullable
private ImageIcon noArchSquareIcon

defaultIcon

@Nullable
private Image defaultIcon

The default icon Image for map previews.

defaultPreview

@Nullable
private Image defaultPreview

The default preview Image for map icon.

treasureListIcon

@Nullable
private Icon treasureListIcon

treasureOneListIcon

@Nullable
private Icon treasureOneListIcon

treasureYesIcon

@Nullable
private Icon treasureYesIcon

treasureNoIcon

@Nullable
private Icon treasureNoIcon

closeTabSmallIcon

@Nullable
private ImageIcon closeTabSmallIcon

autoRunSmallIcon

@Nullable
private Icon autoRunSmallIcon

filterSmallIcon

@Nullable
private Icon filterSmallIcon

runPluginSmallIcon

@Nullable
private Icon runPluginSmallIcon

appIcon

@Nullable
private ImageIcon appIcon

The application's icon or null if none is available.

Constructor Detail

SystemIcons

public SystemIcons(@NotNull
           GUIUtils guiUtils)

Creates a new instance.

Parameters:

guiUtils - the gui utils for creating icons

Method Detail

getMapCursorIcon

@NotNull
public ImageIcon getMapCursorIcon()

getEmptySquareIcon

@NotNull
public Icon getEmptySquareIcon()

getUnknownSquareIcon

@NotNull
public ImageIcon getUnknownSquareIcon()

getWarningSquareIcon

@NotNull
public ImageIcon getWarningSquareIcon()

getLightSquareIcon

@NotNull
public ImageIcon getLightSquareIcon()

Returns the ImageIcon for highlighting map squares that are affected by nearby light emitting game objects.

Returns:

the image icon

getNoFaceSquareIcon

@NotNull
public ImageIcon getNoFaceSquareIcon()

getNoArchSquareIcon

@NotNull
public ImageIcon getNoArchSquareIcon()

getMapSelectedIcon

@NotNull
public ImageIcon getMapSelectedIcon()

getMapSelectedIconNorth

@NotNull
public ImageIcon getMapSelectedIconNorth()

getMapSelectedIconEast

@NotNull
public ImageIcon getMapSelectedIconEast()

getMapSelectedIconSouth

@NotNull
public ImageIcon getMapSelectedIconSouth()

getMapSelectedIconWest

@NotNull
public ImageIcon getMapSelectedIconWest()

getMapPreSelectedIcon

@NotNull
public ImageIcon getMapPreSelectedIcon()

getDefaultIcon

@NotNull
public Image getDefaultIcon()

Returns the default icon Image for map previews.

Returns:

the image

getDefaultPreview

@NotNull
public Image getDefaultPreview()

Returns the default preview Image for map icon.

Returns:

the image

getTreasureListIcon

@NotNull
public Icon getTreasureListIcon()

getTreasureOneListIcon

@NotNull
public Icon getTreasureOneListIcon()

getTreasureYesIcon

@NotNull
public Icon getTreasureYesIcon()

getTreasureNoIcon

@NotNull
public Icon getTreasureNoIcon()

getCloseTabSmallIcon

@NotNull
public ImageIcon getCloseTabSmallIcon()

getAutoRunSmallIcon

@NotNull
public Icon getAutoRunSmallIcon()

getFilterSmallIcon

@NotNull
public Icon getFilterSmallIcon()

getRunPluginSmallIcon

@NotNull
public Icon getRunPluginSmallIcon()

getAppIcon

@Nullable
public ImageIcon getAppIcon()

Returns the application's icon.

Returns:

the icon or null if none is available