com.sun.rave.designtime
Class BasicDisplayActionSet

java.lang.Object

  com.sun.rave.designtime.BasicDisplayAction

      com.sun.rave.designtime.BasicDisplayActionSet

All Implemented Interfaces:

DisplayAction, DisplayActionSet, DisplayItem

public class BasicDisplayActionSet

extends BasicDisplayAction

implements DisplayActionSet

A basic implementation of DisplayActionSet to use for convenience.

Version:

1.0

Author:

Joe Nuxoll

See Also:

DisplayActionSet

Field Summary

protected java.util.ArrayList	actionList
protected boolean	popup

Fields inherited from class com.sun.rave.designtime.BasicDisplayAction

description, displayName, EMPTY_ARRAY, enabled, helpKey, largeIcon, smallIcon

Constructor Summary

BasicDisplayActionSet()

BasicDisplayActionSet(java.lang.String displayName)

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

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

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

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

Method Summary

void	addDisplayAction(DisplayAction action)
void	addDisplayAction(int index, DisplayAction action)
DisplayAction	getDisplayAction(int index)
int	getDisplayActionCount()
DisplayAction[]	getDisplayActions() Returns the list of contained DisplayAction objects.
boolean	isPopup() Returns true if this DisplayActionSet should be displayed as a pop-up, or false if it is should be represented as a flat container (for example, between separators in a context menu).
void	removeDisplayAction(DisplayAction action)
void	removeDisplayAction(int index)
void	setPopup(boolean popup)

Methods inherited from class com.sun.rave.designtime.BasicDisplayAction

getDescription, getDisplayName, getHelpKey, getLargeIcon, getSmallIcon, invoke, isEnabled, setDescription, setDisplayName, setEnabled, setHelpKey, setLargeIcon, setSmallIcon

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sun.rave.designtime.DisplayAction

invoke, isEnabled

Methods inherited from interface com.sun.rave.designtime.DisplayItem

getDescription, getDisplayName, getHelpKey, getLargeIcon, getSmallIcon

Field Detail

actionList

protected java.util.ArrayList actionList

popup

protected boolean popup

Constructor Detail

BasicDisplayActionSet

public BasicDisplayActionSet()

BasicDisplayActionSet

public BasicDisplayActionSet(java.lang.String displayName)

BasicDisplayActionSet

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

BasicDisplayActionSet

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

BasicDisplayActionSet

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

BasicDisplayActionSet

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

Method Detail

addDisplayAction

public void addDisplayAction(DisplayAction action)

addDisplayAction

public void addDisplayAction(int index,
                             DisplayAction action)

getDisplayAction

public DisplayAction getDisplayAction(int index)

getDisplayActionCount

public int getDisplayActionCount()

getDisplayActions

public DisplayAction[] getDisplayActions()

Description copied from interface: DisplayActionSet

Returns the list of contained DisplayAction objects. These will either be shown in a popup or a flat list depending on the 'isPopup' return value.

Specified by:

getDisplayActions in interface DisplayActionSet

Returns:

An array of DisplayAction objects

isPopup

public boolean isPopup()

Description copied from interface: DisplayActionSet

Returns true if this DisplayActionSet should be displayed as a pop-up, or false if it is should be represented as a flat container (for example, between separators in a context menu).

Specified by:

isPopup in interface DisplayActionSet

Returns:

true if this DisplayActionSet should be displayed as a pop-up, or false if it is should be represented as a flat container (for example, between separators in a context menu)

removeDisplayAction

public void removeDisplayAction(DisplayAction action)

removeDisplayAction

public void removeDisplayAction(int index)

setPopup

public void setPopup(boolean popup)