org.apache.myfaces.custom.navmenu
Class UINavigationMenuItem
java.lang.Object
   javax.faces.component.UIComponent
javax.faces.component.UIComponent
       javax.faces.component.UIComponentBase
javax.faces.component.UIComponentBase
           javax.faces.component.UISelectItem
javax.faces.component.UISelectItem
               org.apache.myfaces.custom.navmenu.AbstractUINavigationMenuItem
org.apache.myfaces.custom.navmenu.AbstractUINavigationMenuItem
                   org.apache.myfaces.custom.navmenu.UINavigationMenuItem
org.apache.myfaces.custom.navmenu.UINavigationMenuItem
- All Implemented Interfaces: 
- javax.faces.component.ActionSource, javax.faces.component.StateHolder, UserRoleAware
- public class UINavigationMenuItem 
- extends AbstractUINavigationMenuItem
 
| Fields inherited from class javax.faces.component.UIComponent | 
| bindings | 
 
 
 
 
| Methods inherited from class org.apache.myfaces.custom.navmenu.AbstractUINavigationMenuItem | 
| addActionListener, broadcast, deactivateAll, deactivateChildren, getAction, getActionListeners, getActiveDirectly, getActiveOnViewIdsDirectly, isRendered, removeActionListener, setAction, toggleActive | 
 
| Methods inherited from class javax.faces.component.UISelectItem | 
| getItemDescription, getItemLabel, getItemValue, getValue, isItemDisabled, isItemEscaped, setItemDescription, setItemDisabled, setItemEscaped, setItemLabel, setItemValue, setRendered, setValue | 
 
| Methods inherited from class javax.faces.component.UIComponentBase | 
| addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendererType, setTransient, setValueBinding | 
 
| Methods inherited from class javax.faces.component.UIComponent | 
| encodeAll, getContainerClientId, getValueExpression, setValueExpression | 
 
| Methods inherited from class java.lang.Object | 
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
 
COMPONENT_FAMILY
public static final String COMPONENT_FAMILY
- See Also:
- Constant Field Values
COMPONENT_TYPE
public static final String COMPONENT_TYPE
- See Also:
- Constant Field Values
UINavigationMenuItem
public UINavigationMenuItem()
getFamily
public String getFamily()
- 
- Overrides:
- getFamilyin class- AbstractUINavigationMenuItem
 
- 
 
getIcon
public String getIcon()
- 
- Specified by:
- getIconin class- AbstractUINavigationMenuItem
 
- 
 
setIcon
public void setIcon(String icon)
- 
 
isSplit
public boolean isSplit()
- 
- Specified by:
- isSplitin class- AbstractUINavigationMenuItem
 
- 
 
setSplit
public void setSplit(boolean split)
- 
 
isOpen
public boolean isOpen()
- 
- Specified by:
- isOpenin class- AbstractUINavigationMenuItem
 
- 
 
setOpen
public void setOpen(boolean open)
- 
- Specified by:
- setOpenin class- AbstractUINavigationMenuItem
 
- 
 
isActive
public boolean isActive()
- 
- Specified by:
- isActivein class- AbstractUINavigationMenuItem
 
- 
 
setActive
public void setActive(boolean active)
- 
- Specified by:
- setActivein class- AbstractUINavigationMenuItem
 
- 
 
isImmediate
public boolean isImmediate()
- 
- Specified by:
- isImmediatein interface- javax.faces.component.ActionSource
- Specified by:
- isImmediatein class- AbstractUINavigationMenuItem
 
- 
 
setImmediate
public void setImmediate(boolean immediate)
- 
 
getExternalLink
public String getExternalLink()
- 
- Specified by:
- getExternalLinkin class- AbstractUINavigationMenuItem
 
- 
 
setExternalLink
public void setExternalLink(String externalLink)
- 
 
getActionExpression
public javax.el.MethodExpression getActionExpression()
- Description copied from class: AbstractUINavigationMenuItem
- Specifies the action to take when this command is invoked.
 If the value is an expression, it is expected to be a method 
 binding EL expression that identifies an action method. An action method
 accepts no parameters and has a String return value, called the action
 outcome, that identifies the next view displayed. The phase that this
 event is fired in can be controlled via the immediate attribute.
 If the value is a string literal, it is treated as a navigation outcome
 for the current view.  This is functionally equivalent to a reference to
 an action method that returns the string literal.
 
- 
- Specified by:
- getActionExpressionin class- AbstractUINavigationMenuItem
 
- 
 
setActionExpression
public void setActionExpression(javax.el.MethodExpression actionExpression)
- 
- Specified by:
- setActionExpressionin class- AbstractUINavigationMenuItem
 
- 
 
getActionListener
public javax.faces.el.MethodBinding getActionListener()
- Description copied from class: AbstractUINavigationMenuItem
- A method binding EL expression that identifies an action listener method
 to be invoked if this component is activated by the user. An action
 listener method accepts a parameter of type javax.faces.event.ActionEvent
 and returns void. The phase that this event is fired in can be controlled
 via the immediate attribute.
 
- 
- Specified by:
- getActionListenerin interface- javax.faces.component.ActionSource
- Specified by:
- getActionListenerin class- AbstractUINavigationMenuItem
 
- 
 
setActionListener
public void setActionListener(javax.faces.el.MethodBinding actionListener)
- 
- Specified by:
- setActionListenerin interface- javax.faces.component.ActionSource
- Specified by:
- setActionListenerin class- AbstractUINavigationMenuItem
 
- 
 
getTarget
public String getTarget()
- 
- Specified by:
- getTargetin class- AbstractUINavigationMenuItem
 
- 
 
setTarget
public void setTarget(String target)
- 
 
isDisabled
public boolean isDisabled()
- Description copied from class: AbstractUINavigationMenuItem
- When set instead of a Hyperlink a span tag is rendered in 
 the corresponding Component
 
- 
- Specified by:
- isDisabledin class- AbstractUINavigationMenuItem
 
- 
 
setDisabled
public void setDisabled(boolean disabled)
- 
 
getDisabledStyle
public String getDisabledStyle()
- Description copied from class: AbstractUINavigationMenuItem
- CSS-Style Attribute to render when disabled is true
 
- 
- Specified by:
- getDisabledStylein class- AbstractUINavigationMenuItem
 
- 
 
setDisabledStyle
public void setDisabledStyle(String disabledStyle)
- 
 
getDisabledStyleClass
public String getDisabledStyleClass()
- Description copied from class: AbstractUINavigationMenuItem
- CSS-Style Class to use when disabled is true
 
- 
- Specified by:
- getDisabledStyleClassin class- AbstractUINavigationMenuItem
 
- 
 
setDisabledStyleClass
public void setDisabledStyleClass(String disabledStyleClass)
- 
 
getLocalActiveOnViewIds
protected final String getLocalActiveOnViewIds()
- 
- Specified by:
- getLocalActiveOnViewIdsin class- AbstractUINavigationMenuItem
 
- 
 
getActiveOnViewIds
public String getActiveOnViewIds()
- 
- Specified by:
- getActiveOnViewIdsin class- AbstractUINavigationMenuItem
 
- 
 
setActiveOnViewIds
public void setActiveOnViewIds(String activeOnViewIds)
- 
 
getEnabledOnUserRole
public String getEnabledOnUserRole()
- Description copied from interface: UserRoleAware
- If user is in given role, this component will be rendered 
 normally. If not, no hyperlink is rendered but all nested 
 tags (=body) are rendered.
 
- 
- Returns:
 
setEnabledOnUserRole
public void setEnabledOnUserRole(String enabledOnUserRole)
- 
 
getVisibleOnUserRole
public String getVisibleOnUserRole()
- Description copied from interface: UserRoleAware
- If user is in given role, this component will be rendered 
  normally. If not, nothing is rendered and the body of this 
  tag will be skipped.
 
- 
- Returns:
 
setVisibleOnUserRole
public void setVisibleOnUserRole(String visibleOnUserRole)
- 
 
saveState
public Object saveState(javax.faces.context.FacesContext facesContext)
- 
- Specified by:
- saveStatein interface- javax.faces.component.StateHolder
- Overrides:
- saveStatein class- javax.faces.component.UISelectItem
 
- 
 
restoreState
public void restoreState(javax.faces.context.FacesContext facesContext,
                         Object state)
- 
- Specified by:
- restoreStatein interface- javax.faces.component.StateHolder
- Overrides:
- restoreStatein class- javax.faces.component.UISelectItem
 
- 
 
Copyright © 2012 The Apache Software Foundation. All Rights Reserved.