com.sun.rave.designtime
Interface DisplayActionSet

All Superinterfaces:

DisplayAction, DisplayItem

All Known Implementing Classes:

BasicDisplayActionSet

public interface DisplayActionSet

extends DisplayAction

An extension of the DisplayAction interface that introduces a hierarchy (tree) structure. This allows a DisplayAction to become an arbitrary tree of items. If displayed in a menu, the DisplayActionSet is either a popup item (if isPopup() returns true), or it is displayed as a flat list of items between separators. If displayed as a button (in an option dialog), the DisplayActionSet defines a button with a popup menu on it. Note that the 'invoke()' method will never be called in a DisplayActionSet.

IMPLEMENTED BY THE COMPONENT AUTHOR - This interface is designed to be implemented by the component (bean) author.

Version:

1.0

Author:

Joe Nuxoll

Method Summary

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).

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

Method Detail

getDisplayActions

public DisplayAction[] getDisplayActions()

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.

Returns:

An array of DisplayAction objects

isPopup

public 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).

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)