Class IconFactory

java.lang.Object

org.fife.rsta.ac.java.IconFactory

public final class IconFactory
extends Object

Holds icons used by Java auto-completion.

Version:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IconFactory.IconData	Information about an icon.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ABSTRACT_ICON
static final String	CLASS_ICON
static final String	CONSTRUCTOR_ICON
static final String	DEFAULT_CLASS_ICON
static final String	DEFAULT_INTERFACE_ICON
static final String	DEPRECATED_ICON
static final String	ENUM_DEFAULT_ICON
static final String	ENUM_ICON
static final String	ENUM_PRIVATE_ICON
static final String	ENUM_PROTECTED_ICON
static final String	FIELD_DEFAULT_ICON
static final String	FIELD_PRIVATE_ICON
static final String	FIELD_PROTECTED_ICON
static final String	FIELD_PUBLIC_ICON
static final String	FINAL_ICON
private Map<String,Icon>	iconMap
static final String	IMPORT_ICON
static final String	IMPORT_ROOT_ICON
static final String	INNER_CLASS_DEFAULT_ICON
static final String	INNER_CLASS_PRIVATE_ICON
static final String	INNER_CLASS_PROTECTED_ICON
static final String	INNER_CLASS_PUBLIC_ICON
private static final IconFactory	INSTANCE
static final String	INTERFACE_ICON
static final String	JAVADOC_ITEM_ICON
static final String	LOCAL_VARIABLE_ICON
static final String	METHOD_DEFAULT_ICON
static final String	METHOD_PRIVATE_ICON
static final String	METHOD_PROTECTED_ICON
static final String	METHOD_PUBLIC_ICON
static final String	PACKAGE_ICON
static final String	SOURCE_FILE_ICON
static final String	STATIC_ICON
static final String	TEMPLATE_ICON

Constructor Summary

Constructors

Modifier	Constructor	Description
private	IconFactory()

Method Summary

Modifier and Type	Method	Description
static IconFactory	get()	Returns the singleton instance of this class.
Icon	getIcon(String key)	Returns a known icon.
Icon	getIcon(String key, boolean deprecated)	Returns a known icon, possibly marked as deprecated.
Icon	getIcon(IconFactory.IconData data)	Creates and returns an icon based on the properties provided.
private Icon	loadIcon(String name)

Methods inherited from class Object

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

Field Details

SOURCE_FILE_ICON

public static final String SOURCE_FILE_ICON

See Also:

• Constant Field Values

PACKAGE_ICON

public static final String PACKAGE_ICON

See Also:

• Constant Field Values

IMPORT_ROOT_ICON

public static final String IMPORT_ROOT_ICON

See Also:

• Constant Field Values

IMPORT_ICON

public static final String IMPORT_ICON

See Also:

• Constant Field Values

DEFAULT_CLASS_ICON

public static final String DEFAULT_CLASS_ICON

See Also:

• Constant Field Values

DEFAULT_INTERFACE_ICON

public static final String DEFAULT_INTERFACE_ICON

See Also:

• Constant Field Values

CLASS_ICON

public static final String CLASS_ICON

See Also:

• Constant Field Values

ENUM_ICON

public static final String ENUM_ICON

See Also:

• Constant Field Values

ENUM_PROTECTED_ICON

public static final String ENUM_PROTECTED_ICON

See Also:

• Constant Field Values

ENUM_PRIVATE_ICON

public static final String ENUM_PRIVATE_ICON

See Also:

• Constant Field Values

ENUM_DEFAULT_ICON

public static final String ENUM_DEFAULT_ICON

See Also:

• Constant Field Values

INNER_CLASS_PUBLIC_ICON

public static final String INNER_CLASS_PUBLIC_ICON

See Also:

• Constant Field Values

INNER_CLASS_PROTECTED_ICON

public static final String INNER_CLASS_PROTECTED_ICON

See Also:

• Constant Field Values

INNER_CLASS_PRIVATE_ICON

public static final String INNER_CLASS_PRIVATE_ICON

See Also:

• Constant Field Values

INNER_CLASS_DEFAULT_ICON

public static final String INNER_CLASS_DEFAULT_ICON

See Also:

• Constant Field Values

INTERFACE_ICON

public static final String INTERFACE_ICON

See Also:

• Constant Field Values

JAVADOC_ITEM_ICON

public static final String JAVADOC_ITEM_ICON

See Also:

• Constant Field Values

LOCAL_VARIABLE_ICON

public static final String LOCAL_VARIABLE_ICON

See Also:

• Constant Field Values

METHOD_PUBLIC_ICON

public static final String METHOD_PUBLIC_ICON

See Also:

• Constant Field Values

METHOD_PROTECTED_ICON

public static final String METHOD_PROTECTED_ICON

See Also:

• Constant Field Values

METHOD_PRIVATE_ICON

public static final String METHOD_PRIVATE_ICON

See Also:

• Constant Field Values

METHOD_DEFAULT_ICON

public static final String METHOD_DEFAULT_ICON

See Also:

• Constant Field Values

TEMPLATE_ICON

public static final String TEMPLATE_ICON

See Also:

• Constant Field Values

FIELD_PUBLIC_ICON

public static final String FIELD_PUBLIC_ICON

See Also:

• Constant Field Values

FIELD_PROTECTED_ICON

public static final String FIELD_PROTECTED_ICON

See Also:

• Constant Field Values

FIELD_PRIVATE_ICON

public static final String FIELD_PRIVATE_ICON

See Also:

• Constant Field Values

FIELD_DEFAULT_ICON

public static final String FIELD_DEFAULT_ICON

See Also:

• Constant Field Values

CONSTRUCTOR_ICON

public static final String CONSTRUCTOR_ICON

See Also:

• Constant Field Values

DEPRECATED_ICON

public static final String DEPRECATED_ICON

See Also:

• Constant Field Values

ABSTRACT_ICON

public static final String ABSTRACT_ICON

See Also:

• Constant Field Values

FINAL_ICON

public static final String FINAL_ICON

See Also:

• Constant Field Values

STATIC_ICON

public static final String STATIC_ICON

See Also:

• Constant Field Values

iconMap

private Map<String,Icon> iconMap

INSTANCE

private static final IconFactory INSTANCE

Constructor Details

IconFactory

private IconFactory()

Method Details

get

public static IconFactory get()

Returns the singleton instance of this class.

Returns:

The singleton instance.

getIcon

public Icon getIcon(String key)

Returns a known icon.

Parameters:

key - The icon to retrieve.

Returns:

The icon.

See Also:

• getIcon(String, boolean)
• getIcon(IconData)

getIcon

public Icon getIcon(String key,
 boolean deprecated)

Returns a known icon, possibly marked as deprecated.

Parameters:

key - The icon to retrieve.

deprecated - Whether to render it as deprecated.

Returns:

The icon.

See Also:

• getIcon(String)
• getIcon(IconData)

getIcon

public Icon getIcon(IconFactory.IconData data)

Creates and returns an icon based on the properties provided.

Parameters:

data - Properties about the icon to create.

Returns:

The icon.

See Also:

• getIcon(String)

loadIcon

private Icon loadIcon(String name)