|
Oracle Fusion Middleware extensions for Applications Core API Reference 11g Release 1 (11.1.1.6) E22562-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.apps.fnd.applcore.patterns.uishell.model.menuInternal.MenuNode
public class MenuNode
Code generic to a Menu Nodes of the menu model. IMPORTANT NOTE: even internally, values that support EL expressions should use the "get" methods to obtain values.
Field Summary | |
---|---|
static java.lang.String |
LABEL_ATTR
|
static java.lang.String |
RENDERED_ATTR
|
Constructor Summary | |
---|---|
MenuNode()
|
Method Summary | |
---|---|
java.lang.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. |
java.lang.String |
getAttributeValueRaw(java.lang.String attrName)
|
java.util.List<MenuNode> |
getChildren()
Get the List of menu item's children. |
java.lang.String |
getCustomizationLayerName()
|
boolean |
getDefaultFocusPath()
Gets the defaultFocusPath attribute of the menu item. |
java.lang.String |
getDestination()
Get the Destination URL of a page for a GET. |
boolean |
getDisabled()
Gets the disabled attribute of the menu item. |
java.lang.String |
getDocumentName()
|
java.lang.String |
getFocusViewId()
Gets the value of the node's focusViewId property. |
protected java.lang.String |
getHandlerId()
Set the MenuContentHandlerImpl's id. |
java.lang.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. |
java.lang.String |
getId()
getId - gets the metadata id of the node. |
java.lang.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. |
java.lang.String |
getLabelAndAccessKey()
getLabelAndAccessKey - get the label and accessKey together in a single string. |
java.lang.String |
getModelId()
Gets the local (shared node's) menu Model's Request map key. |
boolean |
getReadOnly()
Gets the readOnly state of the node. |
MenuNode |
getRefNode()
Get the node whose id matches this node's idref attribute value. |
boolean |
getRendered()
Gets the rendered attribute of the menu item. |
org.apache.myfaces.trinidad.model.XMLMenuModel |
getRootModel()
Get the top-level, root menu model, which contains the entire menu tree. |
java.lang.String |
getRootModelKey()
Get the top-level, root menu model Request Map Key. |
java.lang.String |
getUniqueId()
getUniqueId - gets the unique id of the node. |
boolean |
getVisible()
Gets the visible attribute of the menu item. |
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(java.lang.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(java.util.List<MenuNode> children)
Set the List of menu item's children. |
void |
setCustomizationLayerName(java.lang.String customizationLayerName)
|
void |
setDefaultFocusPath(boolean defaultFocusPath)
Sets the defaultFocusPath attribute of the menu item. |
void |
setDefaultFocusPath(java.lang.String defaultFocusPathStr)
Sets the defaultFocusPath attribute of the menu item. |
void |
setDisabled(boolean disabled)
Sets the disabled attribute of the menu item. |
void |
setDisabled(java.lang.String disabledStr)
Sets the disabled attribute of the menu item. |
void |
setDocumentName(java.lang.String documentName)
|
void |
setFocusViewId(java.lang.String focusViewId)
Sets the value of the node's focusViewId property. |
void |
setHandlerId(java.lang.String handlerId)
setHandlerId - sets the MenuContentHandlerImpl's handlerId on the node. |
void |
setIcon(java.lang.String icon)
Set the icon used by the menu item. |
void |
setId(java.lang.String id)
setId - sets the id of the node. |
void |
setLabel(java.lang.String label)
Set the menu item's label. |
void |
setLabelAndAccessKey(java.lang.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(java.lang.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(java.lang.String readOnlyStr)
Sets the readOnly attribute of the menu item. |
void |
setRendered(boolean rendered)
Sets the rendered attribute of the menu item. |
void |
setRendered(java.lang.String renderedStr)
Sets the rendered attribute of the menu item. |
void |
setResBundleKey(java.lang.String bundleKey)
setResBundleKey - sets the name of the resource bundle used in obtaining the node's label text. |
void |
setResBundleName(java.lang.String bundleName)
setResBundleKey - sets the name of the resource bundle used in obtaining the node's label text. |
void |
setRootModelKey(java.lang.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(java.lang.String visibleStr)
Sets the visible attribute of the menu item. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String RENDERED_ATTR
public static final java.lang.String LABEL_ATTR
Constructor Detail |
---|
public MenuNode()
Method Detail |
---|
public void setLabel(java.lang.String label)
label
- - String name shown in the menu itempublic java.lang.String getLabel()
public void setIcon(java.lang.String icon)
icon
- - the String URI to the icon.public java.lang.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 java.util.List<MenuNode> getChildren()
public void setChildren(java.util.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(java.lang.String focusViewId)
focusViewId
- - string value of the Node's "focusViewId" property.public java.lang.String getFocusViewId()
public void setRendered(java.lang.String renderedStr)
renderedStr
- - string representing a boolean valuepublic void setDisabled(java.lang.String disabledStr)
disabledStr
- - string representing a boolean value or
an EL Expressionpublic void setReadOnly(java.lang.String readOnlyStr)
readOnlyStr
- - string representing a boolean value or EL
expression.public void setVisible(java.lang.String visibleStr)
visibleStr
- - string representing a boolean value or
an EL Expressionpublic void setDefaultFocusPath(java.lang.String defaultFocusPathStr)
defaultFocusPathStr
- - string representing a boolean valuepublic void setAccessKey(java.lang.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(java.lang.String labelAndAccessKey)
labelAndAccessKey
- - either and EL Expression or
a String representing the label and accessKey together.public java.lang.String getLabelAndAccessKey()
public void setId(java.lang.String id)
id
- - the identifier for the node componentpublic java.lang.String getId()
public MenuNode getRefNode()
public java.lang.String doAction()
public java.lang.String getDestination()
public java.lang.String getRootModelKey()
public void setRootModelKey(java.lang.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 java.lang.String getModelId()
public void setModelId(java.lang.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 void setResBundleKey(java.lang.String bundleKey)
bundleKey
- - String name of the resource bundle.public void setResBundleName(java.lang.String bundleName)
bundleName
- - String name of the resource bundle.public void setHandlerId(java.lang.String handlerId)
handlerId
- String uniquely identifying the specific
MenuContentHandlerImpl that created this node.public void postSelectedNode(MenuNode selectedNode)
selectedNode
- - The currently selected menu item.public java.lang.String getUniqueId()
protected java.lang.String getHandlerId()
public org.apache.myfaces.trinidad.model.XMLMenuModel getRootModel()
public void setDocumentName(java.lang.String documentName)
public java.lang.String getDocumentName()
public void setCustomizationLayerName(java.lang.String customizationLayerName)
public java.lang.String getCustomizationLayerName()
public java.lang.String getAttributeValueRaw(java.lang.String attrName)
|
Oracle Fusion Middleware extensions for Applications Core API Reference 11g Release 1 (11.1.1.6) E22562-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |