de.must.markup

Class MustMenuItem

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.Vector<MustMenuNode>

de.must.markup.MustMenuNode

de.must.markup.MustMenuItem

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<MustMenuNode>, java.util.Collection<MustMenuNode>, java.util.List<MustMenuNode>, java.util.RandomAccess

public class MustMenuItem
extends MustMenuNode

Menu item. May be represented by an icon or by text. May be embedded in a tree with menus and submenus or in a tool bar.

See Also:

Serialized Form

Field Summary

Fields inherited from class de.must.markup.MustMenuNode

toolTipText, type, TYPE_MENU, TYPE_MENU_ITEM

Fields inherited from class java.util.Vector

capacityIncrement, elementCount, elementData

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
MustMenuItem(java.lang.String label, java.lang.Class<? extends Invokable> actionClass) Constructs a new text menu item
MustMenuItem(java.lang.String label, java.lang.Class<? extends Invokable> actionClass, java.lang.String toolTipText) Constructs a new text menu item.
MustMenuItem(java.lang.String label, FreeAction freeAction) Constructs a new menu item with the specified action.
MustMenuItem(java.lang.String label, FreeAction freeAction, java.lang.String toolTipText) Constructs a new menu item with the specified action.
MustMenuItem(java.lang.String label, Href href) Constructs a new menu item with the specified hyper reference.
MustMenuItem(java.lang.String label, Href href, java.lang.String toolTipText) Constructs a new menu item with the specified hyper reference.
MustMenuItem(java.lang.String label, java.lang.String actionID) Constructs a new menu item with the specified action.
MustMenuItem(java.lang.String label, java.lang.String actionID, java.lang.String toolTipText) Constructs a new menu item with the specified action.
MustMenuItem(ToolBarIcon toolBarIcon, java.lang.Class<? extends Invokable> actionClass) Constructs a new icon menu item
MustMenuItem(ToolBarIcon toolBarIcon, java.lang.Class<? extends Invokable> actionClass, java.lang.String toolTipText) Constructs a new icon menu item.
MustMenuItem(ToolBarIcon toolBarIcon, java.lang.String actionID) Constructs a new menu item with the specified action.
MustMenuItem(ToolBarIcon toolBarIcon, java.lang.String actionID, java.lang.String toolTipText) Constructs a new menu item with the specified action.

Method Summary

Modifier and Type	Method and Description
java.lang.Class<? extends Invokable>	getActionClass() Return the item's action class.
java.lang.String	getActionId() Return the item's action ID.
java.lang.String	getCreationTag(MustMenuBar menuBar, int itemPointer, java.lang.String actionForPost) Returns the tag to markup the menu item.
java.lang.String	getCreationTag(java.lang.String label, java.lang.String actionID, SessionData sessionData) Returns the node's creation tag.
java.lang.String	getLabel() Return the item's label.
boolean	isAllowed(SessionData sessionData) Returns true if the item is allowed in the session's context.

Methods inherited from class de.must.markup.MustMenuNode

getDescription, getToolTipText, getType, setDescription

Methods inherited from class java.util.Vector

add, add, addAll, addAll, addElement, capacity, clear, clone, contains, containsAll, copyInto, elementAt, elements, ensureCapacity, equals, firstElement, forEach, get, hashCode, indexOf, indexOf, insertElementAt, isEmpty, iterator, lastElement, lastIndexOf, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeAllElements, removeElement, removeElementAt, removeIf, removeRange, replaceAll, retainAll, set, setElementAt, setSize, size, sort, spliterator, subList, toArray, toArray, toString, trimToSize

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

MustMenuItem

public MustMenuItem(ToolBarIcon toolBarIcon,
                    java.lang.Class<? extends Invokable> actionClass)

Constructs a new icon menu item

Parameters:

toolBarIcon - the item's tool bar icon

actionClass - the assigned action class

MustMenuItem

public MustMenuItem(ToolBarIcon toolBarIcon,
                    java.lang.Class<? extends Invokable> actionClass,
                    java.lang.String toolTipText)

Constructs a new icon menu item.

Parameters:

toolBarIcon - the item's tool bar icon

actionClass - the assigned action class

toolTipText - the item's tool tip text

MustMenuItem

public MustMenuItem(java.lang.String label,
                    java.lang.Class<? extends Invokable> actionClass)

Constructs a new text menu item

Parameters:

label - the item's label

actionClass - the assigned action class

MustMenuItem

public MustMenuItem(java.lang.String label,
                    java.lang.Class<? extends Invokable> actionClass,
                    java.lang.String toolTipText)

Constructs a new text menu item.

Parameters:

label - the item's label

actionClass - the assigned action class

toolTipText - the item's tool tip text

MustMenuItem

public MustMenuItem(java.lang.String label,
                    java.lang.String actionID)

Constructs a new menu item with the specified action.

Parameters:

label - the item's label

actionId - the ID of the action to be done - see constants NAME_FOR_???_ACTION in Dialog

MustMenuItem

public MustMenuItem(java.lang.String label,
                    java.lang.String actionID,
                    java.lang.String toolTipText)

Constructs a new menu item with the specified action.

Parameters:

label - the item's label

actionId - the ID of the action to be done - see constants NAME_FOR_???_ACTION in Dialog

toolTipText - the item's tool tip text

MustMenuItem

public MustMenuItem(ToolBarIcon toolBarIcon,
                    java.lang.String actionID)

Constructs a new menu item with the specified action.

Parameters:

toolBarIcon - the item's tool bar icon

actionId - the ID of the action to be done - see constants NAME_FOR_???_ACTION in Dialog

MustMenuItem

public MustMenuItem(ToolBarIcon toolBarIcon,
                    java.lang.String actionID,
                    java.lang.String toolTipText)

Constructs a new menu item with the specified action.

Parameters:

toolBarIcon - the item's tool bar icon

actionId - the ID of the action to be done - see constants NAME_FOR_???_ACTION in Dialog

toolTipText - the item's tool tip text

MustMenuItem

public MustMenuItem(java.lang.String label,
                    FreeAction freeAction)

Constructs a new menu item with the specified action.

Parameters:

label - the item's label

freeAction - the free action to be done

MustMenuItem

public MustMenuItem(java.lang.String label,
                    FreeAction freeAction,
                    java.lang.String toolTipText)

Constructs a new menu item with the specified action.

Parameters:

label - the item's label

freeAction - the free action to be done

toolTipText - the item's tool tip text

MustMenuItem

public MustMenuItem(java.lang.String label,
                    Href href)

Constructs a new menu item with the specified hyper reference.

Parameters:

label - the item's label

href - the hyper reference

MustMenuItem

public MustMenuItem(java.lang.String label,
                    Href href,
                    java.lang.String toolTipText)

Constructs a new menu item with the specified hyper reference.

Parameters:

label - the item's label

href - the hyper reference

toolTipText - the item's tool tip text

Method Detail

getLabel

public java.lang.String getLabel()

Return the item's label.

Returns:

the item's label

getActionClass

public java.lang.Class<? extends Invokable> getActionClass()

Return the item's action class.

Returns:

the item's action class

getActionId

public java.lang.String getActionId()

Return the item's action ID.

Returns:

the item's action ID

getCreationTag

public java.lang.String getCreationTag(java.lang.String label,
                                       java.lang.String actionID,
                                       SessionData sessionData)

Returns the node's creation tag.

Overrides:

getCreationTag in class MustMenuNode

Parameters:

label - the label to be displayed

actionId - the action ID

sessionData - the session's public data

Returns:

the tag to markup the menu node

getCreationTag

public java.lang.String getCreationTag(MustMenuBar menuBar,
                                       int itemPointer,
                                       java.lang.String actionForPost)

Returns the tag to markup the menu item.

Overrides:

getCreationTag in class MustMenuNode

Parameters:

menuBar - the menu bar - needed for address

itemPointer - the item pointer - needed for address

actionForPost - the actio for post

Returns:

the tag to markup the menu item

isAllowed

public boolean isAllowed(SessionData sessionData)

Returns true if the item is allowed in the session's context.

Specified by:

isAllowed in class MustMenuNode

Parameters:

sessionData - the session's public data

Returns:

true if the item is allowed in the session's context