Package docking.actions.dialog

Class ActionsModel

java.lang.Object

javax.swing.AbstractListModel<SearchListEntry<DockingActionIf>>

docking.widgets.searchlist.DefaultSearchListModel<DockingActionIf>

docking.actions.dialog.ActionsModel

All Implemented Interfaces:

SearchListModel<DockingActionIf>, Serializable, ListModel<SearchListEntry<DockingActionIf>>

public class ActionsModel
extends DefaultSearchListModel<DockingActionIf>

Model for the SearchList used by the ActionChooserDialog. This model is constructed with two sets of actions; local and global. The local actions are actions that are specific to the currently focused ComponentProvider or DialogComponentProvider. Global actions are actions that are added at the tool level and are not specific to a ComponentProvider or DialogComponentProvider.

The model supports the concept of a ActionDisplayLevel. The display level determines which combination of local and global actions to display and takes into account if they are valid for the current context, are enabled for the current context and, for popups, the value of the "addToPopup" value. Each higher display level is less restrictive and adds more actions in the displayed list. See the ActionDisplayLevel for a description of which actions are displayed for each level

See Also:

• Serialized Form

Field Summary

Fields inherited from class javax.swing.AbstractListModel

listenerList

Method Summary

Modifier and Type	Method	Description
void	dispose()	Clean up any resources held by the model
ActionDisplayLevel	getActionDisplayLevel()	Returns the current ActionDisplayLevel of the dialog.
boolean	isDisposed()
void	setDisplayLevel(ActionDisplayLevel level)	Sets the display level for the actions dialog.

Methods inherited from class docking.widgets.searchlist.DefaultSearchListModel

add, clearData, fireDataChanged, getAllItems, getCategories, getDisplayedItems, getElementAt, getSize, setFilter

Methods inherited from class javax.swing.AbstractListModel

addListDataListener, fireContentsChanged, fireIntervalAdded, fireIntervalRemoved, getListDataListeners, getListeners, removeListDataListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.swing.ListModel

addListDataListener, removeListDataListener

Method Details

setDisplayLevel

public void setDisplayLevel(ActionDisplayLevel level)

Sets the display level for the actions dialog. Each higher level includes more actions in the displayed list of actions.

Parameters:

level - the ActionDisplayLevel

getActionDisplayLevel

public ActionDisplayLevel getActionDisplayLevel()

Returns the current ActionDisplayLevel of the dialog.

Returns:

the current display level of the dialog

dispose

public void dispose()

Description copied from interface: SearchListModel

Clean up any resources held by the model

Specified by:

dispose in interface SearchListModel<DockingActionIf>

Overrides:

dispose in class DefaultSearchListModel<DockingActionIf>

isDisposed

public boolean isDisposed()