com.sun.rave.designtime
Class BasicDisplayAction

java.lang.Object

  com.sun.rave.designtime.BasicDisplayAction

All Implemented Interfaces:

DisplayAction, DisplayItem

Direct Known Subclasses:

BasicCheckedDisplayAction, BasicDisplayActionSet

public class BasicDisplayAction

extends java.lang.Object

implements DisplayAction

A basic implementation of DisplayAction to use for convenience.

Version:

1.0

Author:

Joe Nuxoll

See Also:

DisplayAction

Field Summary

protected java.lang.String	description
protected java.lang.String	displayName
static DisplayAction[]	EMPTY_ARRAY
protected boolean	enabled
protected java.lang.String	helpKey
protected java.awt.Image	largeIcon
protected java.awt.Image	smallIcon

Constructor Summary

BasicDisplayAction()

BasicDisplayAction(java.lang.String displayName)

BasicDisplayAction(java.lang.String displayName, java.lang.String description)

BasicDisplayAction(java.lang.String displayName, java.lang.String description, java.lang.String helpKey)

BasicDisplayAction(java.lang.String displayName, java.lang.String description, java.lang.String helpKey, java.awt.Image smallIcon)

BasicDisplayAction(java.lang.String displayName, java.lang.String description, java.lang.String helpKey, java.awt.Image smallIcon, java.awt.Image largeIcon)

Method Summary

java.lang.String	getDescription() Returns a description for this item.
java.lang.String	getDisplayName() Returns a display name for this item.
java.lang.String	getHelpKey() Returns the help key for this item.
java.awt.Image	getLargeIcon() Returns a large image icon for this item.
java.awt.Image	getSmallIcon() Returns a small image icon for this item.
Result	invoke() This method is called when a DisplayAction is selected from a context menu or 'clicked' when it is displayed as a button.
boolean	isEnabled() Returns true if this DisplayAction should be displayed as enabled, or false if it should be disabled.
void	setDescription(java.lang.String description)
void	setDisplayName(java.lang.String displayName)
void	setEnabled(boolean enabled)
void	setHelpKey(java.lang.String helpKey)
void	setLargeIcon(java.awt.Image largeIcon)
void	setSmallIcon(java.awt.Image smallIcon)

Methods inherited from class java.lang.Object

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

Field Detail

description

protected java.lang.String description

displayName

protected java.lang.String displayName

EMPTY_ARRAY

public static final DisplayAction[] EMPTY_ARRAY

enabled

protected boolean enabled

helpKey

protected java.lang.String helpKey

largeIcon

protected java.awt.Image largeIcon

smallIcon

protected java.awt.Image smallIcon

Constructor Detail

BasicDisplayAction

public BasicDisplayAction()

BasicDisplayAction

public BasicDisplayAction(java.lang.String displayName)

BasicDisplayAction

public BasicDisplayAction(java.lang.String displayName,
                          java.lang.String description)

BasicDisplayAction

public BasicDisplayAction(java.lang.String displayName,
                          java.lang.String description,
                          java.lang.String helpKey)

BasicDisplayAction

public BasicDisplayAction(java.lang.String displayName,
                          java.lang.String description,
                          java.lang.String helpKey,
                          java.awt.Image smallIcon)

BasicDisplayAction

public BasicDisplayAction(java.lang.String displayName,
                          java.lang.String description,
                          java.lang.String helpKey,
                          java.awt.Image smallIcon,
                          java.awt.Image largeIcon)

Method Detail

getDescription

public java.lang.String getDescription()

Description copied from interface: DisplayItem

Returns a description for this item. This will be used as a tooltip in a menu or on a button, depending on the subinterface.

Specified by:

getDescription in interface DisplayItem

Returns:

A String representing the description for this item.

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: DisplayItem

Returns a display name for this item. This will be used to show in a menu or as a button label, depending on the subinterface.

Specified by:

getDisplayName in interface DisplayItem

Returns:

A String representing the display name for this item.

getHelpKey

public java.lang.String getHelpKey()

Description copied from interface: DisplayItem

Returns the help key for this item. This is usually a key used to look up a help context item in an online help facility.

Specified by:

getHelpKey in interface DisplayItem

Returns:

A String representing the help key for this item.

getLargeIcon

public java.awt.Image getLargeIcon()

Description copied from interface: DisplayItem

Returns a large image icon for this item. Generally "large" means 32x32 pixels.

Specified by:

getLargeIcon in interface DisplayItem

Returns:

An Image representing the large icon for this item.

getSmallIcon

public java.awt.Image getSmallIcon()

Description copied from interface: DisplayItem

Returns a small image icon for this item. Generally "small" means 16x16 pixels.

Specified by:

getSmallIcon in interface DisplayItem

Returns:

An Image representing the large icon for this item.

invoke

public Result invoke()

Description copied from interface: DisplayAction

This method is called when a DisplayAction is selected from a context menu or 'clicked' when it is displayed as a button.

Specified by:

invoke in interface DisplayAction

Returns:

A standard Result object

isEnabled

public boolean isEnabled()

Description copied from interface: DisplayAction

Returns true if this DisplayAction should be displayed as enabled, or false if it should be disabled.

Specified by:

isEnabled in interface DisplayAction

Returns:

true if this DisplayAction should be displayed as enabled, or false if it should be disabled.

setDescription

public void setDescription(java.lang.String description)

setDisplayName

public void setDisplayName(java.lang.String displayName)

setEnabled

public void setEnabled(boolean enabled)

setHelpKey

public void setHelpKey(java.lang.String helpKey)

setLargeIcon

public void setLargeIcon(java.awt.Image largeIcon)

setSmallIcon

public void setSmallIcon(java.awt.Image smallIcon)