de.must.markup

Class MustMenuNode

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.Vector<MustMenuNode>

de.must.markup.MustMenuNode

All Implemented Interfaces:

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

Direct Known Subclasses:

MustMenu, MustMenuItem

public abstract class MustMenuNode
extends java.util.Vector<MustMenuNode>

Menu node - may be an menu item, a menu or a submenu.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	toolTipText
protected int	type
static int	TYPE_MENU
static int	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
MustMenuNode(java.lang.String description) Constructs a new menu node.
MustMenuNode(java.lang.String description, java.lang.String toolTipText) Constructs a new menu node.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCreationTag(MustMenuBar menuBar, int itemPointer, java.lang.String actionForPost) Returns the node's creation tag.
java.lang.String	getCreationTag(java.lang.String label, java.lang.String actionID, SessionData sessionData) Returns the node's creation tag.
java.lang.String	getDescription() Returns the node's description.
java.lang.String	getToolTipText() Returns the node's tool tip text.
int	getType() Returns the node's type.
abstract boolean	isAllowed(SessionData sessionData) Returns true if the menu node is allowed in the session context.
void	setDescription(java.lang.String newDescription) Sets the node's description.

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

Field Detail

TYPE_MENU

public static final int TYPE_MENU

See Also:

Constant Field Values

TYPE_MENU_ITEM

public static final int TYPE_MENU_ITEM

See Also:

Constant Field Values

type

protected int type

toolTipText

protected java.lang.String toolTipText

Constructor Detail

MustMenuNode

public MustMenuNode(java.lang.String description)

Constructs a new menu node.

Parameters:

description - the node's description

MustMenuNode

public MustMenuNode(java.lang.String description,
                    java.lang.String toolTipText)

Constructs a new menu node.

Parameters:

description - the node's description

toolTipText - the node's tool tip text

Method Detail

getToolTipText

public java.lang.String getToolTipText()

Returns the node's tool tip text.

Returns:

the node's tool tip text

getType

public int getType()

Returns the node's type.

Returns:

the node's type

setDescription

public void setDescription(java.lang.String newDescription)

Sets the node's description.

Parameters:

newDescription - the new description of the node

getDescription

public java.lang.String getDescription()

Returns the node's description.

Returns:

the node's description

getCreationTag

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

Returns the node's creation tag.

Parameters:

menuBar - the enclosing menu bar - needed for the address

itemPointer - the item's pointer - needed for the address

actionForPost - the action for post

Returns:

the tag to markup the menu node

getCreationTag

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

Returns the node's creation tag.

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

isAllowed

public abstract boolean isAllowed(SessionData sessionData)

Returns true if the menu node is allowed in the session context.

Parameters:

sessionData - the session's public data