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.HtmlCommandLink
                      extended by org.apache.myfaces.custom.navmenu.htmlnavmenu.HtmlCommandNavigationItem
All Implemented Interfaces:
javax.faces.component.ActionSource, javax.faces.component.StateHolder, UserRoleAware

public class HtmlCommandNavigationItem
extends HtmlCommandLink

Many thanks to the guys from Swiss Federal Institute of Intellectual Property & Marc Bouquet for helping to develop this component.

Author:
Manfred Geiler, Thomas Spiegl

Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_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
 void broadcast(javax.faces.event.FacesEvent event)
           
 void deactivateAll()
           
 void deactivateChildren()
           
 java.lang.Boolean getActiveDirectly()
           
 java.lang.String[] getActiveOnVieIds()
           
 java.lang.String getActiveOnViewIds()
           
 java.lang.String getExternalLink()
           
 java.lang.String getFamily()
           
 java.lang.Boolean getOpenDirectly()
           
 boolean isActive()
           
 boolean isImmediate()
           
 boolean isOpen()
           
 boolean isRendered()
           
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setActive(boolean active)
           
 void setActiveOnViewIds(java.lang.String activeOnViewIds)
           
 void setExternalLink(java.lang.String externalLink)
           
 void setImmediate(java.lang.Boolean immediate)
           
 void setOpen(boolean open)
           
 void toggleOpen()
           
 
Methods inherited from class org.apache.myfaces.component.html.ext.HtmlCommandLink
getActionFor, getClientId, getDisabledStyle, getDisabledStyleClass, getEnabledOnUserRole, getTarget, getVisibleOnUserRole, isDisabled, setActionFor, setDisabled, setDisabledStyle, setDisabledStyleClass, setEnabledOnUserRole, setTarget, setVisibleOnUserRole
 
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, 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, 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_TYPE

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

COMPONENT_FAMILY

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

HtmlCommandNavigationItem

public HtmlCommandNavigationItem()
Method Detail

isImmediate

public boolean isImmediate()
Specified by:
isImmediate in interface javax.faces.component.ActionSource
Overrides:
isImmediate in class javax.faces.component.UICommand

setImmediate

public void setImmediate(java.lang.Boolean immediate)

isOpen

public boolean isOpen()

getOpenDirectly

public java.lang.Boolean getOpenDirectly()

setOpen

public void setOpen(boolean open)

isActive

public boolean isActive()

getActiveDirectly

public java.lang.Boolean getActiveDirectly()

setActive

public void setActive(boolean active)

getActiveOnViewIds

public java.lang.String getActiveOnViewIds()

setActiveOnViewIds

public void setActiveOnViewIds(java.lang.String activeOnViewIds)

getExternalLink

public java.lang.String getExternalLink()

setExternalLink

public void setExternalLink(java.lang.String externalLink)

isRendered

public boolean isRendered()
Overrides:
isRendered in class HtmlCommandLink
Returns:
false, if this item is child of another HtmlCommandNavigation, which is closed

toggleOpen

public void toggleOpen()

getActiveOnVieIds

public java.lang.String[] getActiveOnVieIds()

deactivateAll

public void deactivateAll()

deactivateChildren

public void deactivateChildren()

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException
Overrides:
broadcast in class javax.faces.component.UICommand
Throws:
javax.faces.event.AbortProcessingException

saveState

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

restoreState

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

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class javax.faces.component.UICommand


Copyright © 2011. All Rights Reserved.