org.apache.myfaces.custom.navmenu.htmlnavmenu
Class HtmlCommandNavigationItem

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UICommand
              extended by javax.faces.component.html.HtmlCommandLink
                  extended by org.apache.myfaces.component.html.ext.AbstractHtmlCommandLink
                      extended by org.apache.myfaces.component.html.ext.HtmlCommandLink
                          extended by org.apache.myfaces.custom.navmenu.htmlnavmenu.AbstractHtmlCommandNavigationItem
                              extended by org.apache.myfaces.custom.navmenu.htmlnavmenu.HtmlCommandNavigationItem
All Implemented Interfaces:
javax.faces.component.ActionSource, javax.faces.component.StateHolder, ForceIdAware, UserRoleAware

public class HtmlCommandNavigationItem
extends AbstractHtmlCommandNavigationItem


Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static java.lang.String DEFAULT_RENDERER_TYPE
           
 
Fields inherited from interface org.apache.myfaces.component.UserRoleAware
ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR
 
Constructor Summary
HtmlCommandNavigationItem()
           
 
Method Summary
 java.lang.String getActiveOnViewIds()
          A comma separated list of viewIds for which this item should be active.
 java.lang.String getExternalLink()
          The external link where to redirect when this is clicked.
 java.lang.String getFamily()
           
 boolean isActive()
          Menu node is active.
protected  boolean isLocalActive()
           
protected  boolean isLocalOpen()
           
 boolean isOpen()
          Menu node is open.
protected  boolean isSetActive()
           
protected  boolean isSetOpen()
           
 void restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext facesContext)
           
 void setActive(boolean active)
           
 void setActiveOnViewIds(java.lang.String activeOnViewIds)
           
 void setExternalLink(java.lang.String externalLink)
           
 void setOpen(boolean open)
           
 
Methods inherited from class org.apache.myfaces.custom.navmenu.htmlnavmenu.AbstractHtmlCommandNavigationItem
broadcast, deactivateAll, deactivateChildren, getActiveDirectly, getActiveOnVieIds, getOpenDirectly, isImmediate, isRendered, setImmediate, toggleOpen
 
Methods inherited from class org.apache.myfaces.component.html.ext.HtmlCommandLink
getActionFor, getDisabledStyle, getDisabledStyleClass, getEnabledOnUserRole, getVisibleOnUserRole, isDisabled, isForceId, isForceIdIndex, setActionFor, setDisabled, setDisabledStyle, setDisabledStyleClass, setEnabledOnUserRole, setForceId, setForceIdIndex, setVisibleOnUserRole
 
Methods inherited from class org.apache.myfaces.component.html.ext.AbstractHtmlCommandLink
getClientId
 
Methods inherited from class javax.faces.component.html.HtmlCommandLink
getAccesskey, getCharset, getCoords, getDir, getHreflang, getLang, getOnblur, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getRel, getRev, getShape, getStyle, getStyleClass, getTabindex, getTarget, getTitle, getType, setAccesskey, setCharset, setCoords, setDir, setHreflang, setLang, setOnblur, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setRel, setRev, setShape, setStyle, setStyleClass, setTabindex, setTarget, setTitle, setType
 
Methods inherited from class javax.faces.component.UICommand
addActionListener, getAction, getActionListener, getActionListeners, getValue, queueEvent, removeActionListener, setAction, setActionListener, setImmediate, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

DEFAULT_RENDERER_TYPE

public static final java.lang.String DEFAULT_RENDERER_TYPE
See Also:
Constant Field Values
Constructor Detail

HtmlCommandNavigationItem

public HtmlCommandNavigationItem()
Method Detail

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class HtmlCommandLink

isSetOpen

protected boolean isSetOpen()
Specified by:
isSetOpen in class AbstractHtmlCommandNavigationItem

isLocalOpen

protected final boolean isLocalOpen()
Specified by:
isLocalOpen in class AbstractHtmlCommandNavigationItem

isOpen

public boolean isOpen()
Description copied from class: AbstractHtmlCommandNavigationItem
Menu node is open.

Specified by:
isOpen in class AbstractHtmlCommandNavigationItem

setOpen

public void setOpen(boolean open)
Specified by:
setOpen in class AbstractHtmlCommandNavigationItem

isSetActive

protected boolean isSetActive()
Specified by:
isSetActive in class AbstractHtmlCommandNavigationItem

isLocalActive

protected final boolean isLocalActive()
Specified by:
isLocalActive in class AbstractHtmlCommandNavigationItem

isActive

public boolean isActive()
Description copied from class: AbstractHtmlCommandNavigationItem
Menu node is active.

Specified by:
isActive in class AbstractHtmlCommandNavigationItem

setActive

public void setActive(boolean active)
Specified by:
setActive in class AbstractHtmlCommandNavigationItem

getActiveOnViewIds

public java.lang.String getActiveOnViewIds()
Description copied from class: AbstractHtmlCommandNavigationItem
A comma separated list of viewIds for which this item should be active.

Specified by:
getActiveOnViewIds in class AbstractHtmlCommandNavigationItem

setActiveOnViewIds

public void setActiveOnViewIds(java.lang.String activeOnViewIds)

getExternalLink

public java.lang.String getExternalLink()
Description copied from class: AbstractHtmlCommandNavigationItem
The external link where to redirect when this is clicked.

Specified by:
getExternalLink in class AbstractHtmlCommandNavigationItem

setExternalLink

public void setExternalLink(java.lang.String externalLink)

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext facesContext)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class HtmlCommandLink

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         java.lang.Object state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class HtmlCommandLink


Copyright © 2011 The Apache Software Foundation. All Rights Reserved.