Constructor and Description |
---|
MenuNode()
Constructs a MenuNode
|
Modifier and Type | Method and Description |
---|---|
String |
doAction()
Called by the Default ActionListener
when a menu node is clicked/selected.
|
char |
getAccessKey()
getAccessKey - get the label's accessKey as a char.
|
String |
getAccessKeyProperty() |
String |
getBundleKeyProperty() |
String |
getBundleNameProperty() |
List<MenuNode> |
getChildren()
Get the List of menu item's children.
|
List<MenuNode> |
getChildrenProperty() |
boolean |
getDefaultFocusPath()
Gets the defaultFocusPath attribute of the menu item.
|
String |
getDefaultFocusPathProperty() |
String |
getDestination()
Get the Destination URL of a page for a
GET.
|
boolean |
getDisabled()
Gets the disabled attribute of the menu item.
|
String |
getDisabledProperty() |
String |
getFocusViewId()
Gets the value of the node's focusViewId property.
|
String |
getFocusViewIdProperty() |
protected String |
getHandlerId()
Set the MenuContentHandlerImpl's id.
|
String |
getHandlerIdProperty() |
String |
getIcon()
Get the icon used by the menu item
This could either be a string value set directly in
the metadata or an EL expression string.
|
String |
getIconProperty() |
String |
getId()
getId - gets the metadata id of the node.
|
String |
getIdProperty() |
String |
getLabel()
Get the menu item's label
This could either be a string value set directly in
the metadata or an EL expression string.
|
String |
getLabelAndAccessKey()
getLabelAndAccessKey - get the label and accessKey together
in a single string.
|
String |
getLabelAndAccessKeyProperty() |
String |
getLabelProperty() |
String |
getModelId()
Gets the local (shared node's) menu Model's Request map key.
|
String |
getModelIdProperty() |
boolean |
getReadOnly()
Gets the readOnly state of the node.
|
String |
getReadOnlyProperty() |
MenuNode |
getRefNode()
Get the node whose id matches this node's
idref attribute value.
|
boolean |
getRendered()
Gets the rendered attribute of the menu item.
|
String |
getRenderedProperty() |
int |
getRootId() |
int |
getRootIdProperty() |
protected XMLMenuModel |
getRootModel()
Get the top-level, root menu model, which contains
the entire menu tree.
|
String |
getRootModelKey()
Get the top-level, root menu model Request Map Key.
|
String |
getRootModelKeyProperty() |
MenuNode |
getThreadSafeCopy()
Construct a thread safe version
of this object and return it.
|
String |
getUniqueId()
getUniqueId - gets the unique id of the node.
|
String |
getUniqueIdProperty() |
boolean |
getVisible()
Gets the visible attribute of the menu item.
|
String |
getVisibleProperty() |
protected void |
postSelectedNode(MenuNode selectedNode)
Notifies the root model that this node has been selected on a POST
|
void |
setAccessKey(char accessKey)
setAccessKey - Takes a single character and sets the value of the
accessKey attribute of the node.
|
void |
setAccessKey(String accessKey)
setAccessKey - Takes either a single character String or
an EL expression and sets the value of the accessKey attribute
of the node.
|
void |
setChildren(List<MenuNode> children)
Set the List of menu item's children.
|
void |
setDefaultFocusPath(boolean defaultFocusPath)
Sets the defaultFocusPath attribute of the menu item.
|
void |
setDefaultFocusPath(String defaultFocusPathStr)
Sets the defaultFocusPath attribute of the menu item.
|
void |
setDisabled(boolean disabled)
Sets the disabled attribute of the menu item.
|
void |
setDisabled(String disabledStr)
Sets the disabled attribute of the menu item.
|
void |
setFocusViewId(String focusViewId)
Sets the value of the node's focusViewId property.
|
void |
setHandlerId(String handlerId)
setHandlerId - sets the MenuContentHandlerImpl's handlerId on the node.
|
void |
setIcon(String icon)
Set the icon used by the menu item.
|
void |
setId(String id)
setId - sets the id of the node.
|
void |
setLabel(String label)
Set the menu item's label.
|
void |
setLabelAndAccessKey(String labelAndAccessKey)
setLabelAndAccessKey - Takes either an EL expression or a
String representing the label and accessKey together, and
sets the label and the accessKey separately.
|
void |
setModelId(String modelId)
Sets the local (shared node's) menu Model's Request map key.
|
void |
setReadOnly(boolean readOnly)
Sets the the value of the readOnly attribute of the node.
|
void |
setReadOnly(String readOnlyStr)
Sets the readOnly attribute of the menu item.
|
void |
setRendered(boolean rendered)
Sets the rendered attribute of the menu item.
|
void |
setRendered(String renderedStr)
Sets the rendered attribute of the menu item.
|
void |
setResBundleKey(String bundleKey)
setResBundleKey - sets the name of the resource bundle used in
obtaining the node's label text.
|
void |
setResBundleName(String bundleName)
setResBundleKey - sets the name of the resource bundle used in
obtaining the node's label text.
|
void |
setRootId(int id) |
void |
setRootModelKey(String rootModelKey)
Sets the root menu Model's Request map key.
|
void |
setVisible(boolean visible)
Sets the visible attribute of the menu item.
|
void |
setVisible(String visibleStr)
Sets the visible attribute of the menu item.
|
public void setLabel(String label)
label
- - String name shown in the menu itempublic String getLabel()
public void setIcon(String icon)
icon
- - the String URI to the icon.public String getIcon()
public void setRendered(boolean rendered)
rendered
- - boolean that toggles the visible state of the XMLMenuModel
item.public boolean getRendered()
public void setDisabled(boolean disabled)
disabled
- - boolean that toggles the enabled/disabled state of the
menu item.public boolean getDisabled()
public void setVisible(boolean visible)
visible
- - boolean that toggles the visible state of the
menu item.public boolean getVisible()
public void setDefaultFocusPath(boolean defaultFocusPath)
defaultFocusPath
- - boolean that tells the XMLMenuModel model that
the focus path to this node should be used in cases where the focus path
is not determinable by the XMLMenuModel model.public boolean getDefaultFocusPath()
public List<MenuNode> getChildren()
public void setChildren(List<MenuNode> children)
children
- - List of MenuNode children for this MenuNodepublic boolean getReadOnly()
public void setReadOnly(boolean readOnly)
readOnly
- - boolean setting readOnly state of the nodepublic void setFocusViewId(String focusViewId)
focusViewId
- - string value of the Node's "focusViewId" property.public String getFocusViewId()
public void setRendered(String renderedStr)
renderedStr
- - string representing a boolean valuepublic void setDisabled(String disabledStr)
disabledStr
- - string representing a boolean value or
an EL Expressionpublic void setReadOnly(String readOnlyStr)
readOnlyStr
- - string representing a boolean value or EL
expression.public void setVisible(String visibleStr)
visibleStr
- - string representing a boolean value or
an EL Expressionpublic void setDefaultFocusPath(String defaultFocusPathStr)
defaultFocusPathStr
- - string representing a boolean valuepublic void setAccessKey(String accessKey)
accessKey
- - Single character String or EL expression
representing the label's access key.public void setAccessKey(char accessKey)
accessKey
- - Single character label access key.public char getAccessKey()
public void setLabelAndAccessKey(String labelAndAccessKey)
labelAndAccessKey
- - either and EL Expression or
a String representing the label and accessKey together.public String getLabelAndAccessKey()
public void setId(String id)
id
- - the identifier for the node componentpublic String getId()
public MenuNode getRefNode()
public String doAction()
public String getDestination()
public String getRootModelKey()
public void setRootModelKey(String rootModelKey)
This is always only the top-level, root model's Request map key. We do this because the MenuContentHandlerImpl and nodes need to be able to call into the root model to:
rootModelKey
- - String the root, top-level menu model's Request
map key.public String getModelId()
public void setModelId(String modelId)
This is appended to the node's id to create a unique id.
rootModelKey
- - String the local (shared node's) menu
Model's Request map key.public int getRootId()
public void setRootId(int id)
public final String getLabelProperty()
public final String getIconProperty()
public final String getFocusViewIdProperty()
public final String getRenderedProperty()
public final String getDisabledProperty()
public final String getVisibleProperty()
public final String getReadOnlyProperty()
public final String getHandlerIdProperty()
public final String getBundleKeyProperty()
public final String getBundleNameProperty()
public final String getAccessKeyProperty()
public final String getIdProperty()
public final String getModelIdProperty()
public final String getUniqueIdProperty()
public final String getLabelAndAccessKeyProperty()
public final String getDefaultFocusPathProperty()
public final String getRootModelKeyProperty()
public final int getRootIdProperty()
public void setResBundleKey(String bundleKey)
bundleKey
- - String name of the resource bundle.public void setResBundleName(String bundleName)
bundleName
- - String name of the resource bundle.public void setHandlerId(String handlerId)
handlerId
- String uniquely identifying the specific
MenuContentHandlerImpl that created this node.protected void postSelectedNode(MenuNode selectedNode)
selectedNode
- - The currently selected menu item.public String getUniqueId()
protected String getHandlerId()
protected XMLMenuModel getRootModel()
public MenuNode getThreadSafeCopy()
Copyright © 2001-2017 The Apache Software Foundation. All Rights Reserved.