org.oddjob.images
Class IconHelper

java.lang.Object
  org.oddjob.images.IconHelper

All Implemented Interfaces:

Iconic

public class IconHelper
extends Object
implements Iconic

Icons for the JobTree. All from Anthony's WWW Images. Java Look and Feel Graphics.

Author:

Rob Gordon

Field Summary

static String	ACTIVE
static IconTip	activeIcon
static String	COMPLETE
static IconTip	completeIcon
static String	EXCEPTION
static IconTip	exceptionIcon
static String	EXECUTING
static IconTip	executingIcon
static String	INITIALIZING
static IconTip	initializingIcon
static String	INVALID
static IconTip	invalidIcon
static String	NOT_COMPLETE
static IconTip	notCompleteIcon
static String	NULL
static IconTip	nullIcon
static String	READY
static IconTip	readyIcon
static String	SLEEPING
static IconTip	sleepingIcon
static String	STARTED
static IconTip	startedIcon
static String	STOPPED
static IconTip	stoppedIcon
static String	STOPPING
static IconTip	stoppingIcon

Constructor Summary

IconHelper(Iconic source)

IconHelper(Iconic source, Map<String,IconTip> iconMap)
Constructor.

Method Summary

void	addIconListener(IconListener listener) Add a listener.
void	changeIcon(String iconId) Change the icon by firing an iconEvent.
String	currentId() Get the current/last icon id.
IconTip	iconForId(String iconId) Return an IconTip for the given id.
void	removeIconListener(IconListener listener) Remove a listener.

Methods inherited from class java.lang.Object

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

Field Detail

NULL

public static final String NULL

See Also:

Constant Field Values

INITIALIZING

public static final String INITIALIZING

See Also:

Constant Field Values

READY

public static final String READY

See Also:

Constant Field Values

EXECUTING

public static final String EXECUTING

See Also:

Constant Field Values

COMPLETE

public static final String COMPLETE

See Also:

Constant Field Values

NOT_COMPLETE

public static final String NOT_COMPLETE

See Also:

Constant Field Values

EXCEPTION

public static final String EXCEPTION

See Also:

Constant Field Values

SLEEPING

public static final String SLEEPING

See Also:

Constant Field Values

STOPPING

public static final String STOPPING

See Also:

Constant Field Values

STOPPED

public static final String STOPPED

See Also:

Constant Field Values

STARTED

public static final String STARTED

See Also:

Constant Field Values

ACTIVE

public static final String ACTIVE

See Also:

Constant Field Values

INVALID

public static final String INVALID

See Also:

Constant Field Values

nullIcon

public static final IconTip nullIcon

initializingIcon

public static final IconTip initializingIcon

readyIcon

public static final IconTip readyIcon

executingIcon

public static final IconTip executingIcon

completeIcon

public static final IconTip completeIcon

notCompleteIcon

public static final IconTip notCompleteIcon

stoppingIcon

public static final IconTip stoppingIcon

stoppedIcon

public static final IconTip stoppedIcon

sleepingIcon

public static final IconTip sleepingIcon

invalidIcon

public static final IconTip invalidIcon

exceptionIcon

public static final IconTip exceptionIcon

startedIcon

public static final IconTip startedIcon

activeIcon

public static final IconTip activeIcon

Constructor Detail

IconHelper

public IconHelper(Iconic source)

IconHelper

public IconHelper(Iconic source,
                  Map<String,IconTip> iconMap)

Constructor.

Parameters:

source - The source for events.

Method Detail

iconForId

public IconTip iconForId(String iconId)

Return an IconTip for the given id.

Specified by:

iconForId in interface Iconic

Parameters:

iconId - The id.

Returns:

The iconTip never null.

Throws:

NoSuchIconException - If the icon doesn't exist.

changeIcon

public void changeIcon(String iconId)

Change the icon by firing an iconEvent.

Parameters:

iconId - The icon id.

currentId

public String currentId()

Get the current/last icon id.

Returns:

An iconId.

addIconListener

public void addIconListener(IconListener listener)

Description copied from interface: Iconic

Add a listener.

Specified by:

addIconListener in interface Iconic

Parameters:

listener - The IconListener.

removeIconListener

public void removeIconListener(IconListener listener)

Description copied from interface: Iconic

Remove a listener.

Specified by:

removeIconListener in interface Iconic

Parameters:

listener - The IconListener.