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

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
All Implemented Interfaces:
javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.StateHolder, ForceIdAware, UserRoleAware
Direct Known Subclasses:
HtmlCommandNavigationItem

public abstract class AbstractHtmlCommandNavigationItem
extends HtmlCommandLink

Must be nested inside a panel_navigation action and renders a clickable navigation item. This action is derived from the standard command_link action and has equal attributes. (Replaces former "navigation_item" tag.) Unless otherwise specified, all attributes accept static values or EL expressions. Many thanks to the guys from Swiss Federal Institute of Intellectual Property and Marc Bouquet for helping to develop this component.

Since:
1.1.7
Author:
Manfred Geiler, Thomas Spiegl

Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Fields inherited from interface org.apache.myfaces.component.UserRoleAware
ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR
 
Constructor Summary
AbstractHtmlCommandNavigationItem()
           
 
Method Summary
 void broadcast(javax.faces.event.FacesEvent event)
           
 void deactivateAll()
           
 void deactivateChildren()
           
 java.lang.Boolean getActiveDirectly()
           
 java.lang.String[] getActiveOnVieIds()
           
abstract  java.lang.String getActiveOnViewIds()
          A comma separated list of viewIds for which this item should be active.
abstract  java.lang.String getExternalLink()
          The external link where to redirect when this is clicked.
 java.lang.Boolean getOpenDirectly()
           
abstract  boolean isActive()
          Menu node is active.
 boolean isImmediate()
           
protected abstract  boolean isLocalActive()
           
protected abstract  boolean isLocalOpen()
           
abstract  boolean isOpen()
          Menu node is open.
 boolean isRendered()
           
protected abstract  boolean isSetActive()
           
protected abstract  boolean isSetOpen()
           
abstract  void setActive(boolean active)
           
 void setImmediate(java.lang.Boolean immediate)
           
abstract  void setOpen(boolean open)
           
 void toggleOpen()
           
 
Methods inherited from class org.apache.myfaces.component.html.ext.HtmlCommandLink
getActionFor, getDisabledStyle, getDisabledStyleClass, getEnabledOnUserRole, getFamily, getVisibleOnUserRole, isDisabled, isForceId, isForceIdIndex, restoreState, saveState, 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, getActionExpression, getActionListener, getActionListeners, getValue, queueEvent, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, 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
 

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

AbstractHtmlCommandNavigationItem

public AbstractHtmlCommandNavigationItem()
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 abstract boolean isOpen()
Menu node is open.


isSetOpen

protected abstract boolean isSetOpen()

isLocalOpen

protected abstract boolean isLocalOpen()

setOpen

public abstract void setOpen(boolean open)

getOpenDirectly

public java.lang.Boolean getOpenDirectly()

getActiveDirectly

public java.lang.Boolean getActiveDirectly()

isActive

public abstract boolean isActive()
Menu node is active.


isSetActive

protected abstract boolean isSetActive()

isLocalActive

protected abstract boolean isLocalActive()

setActive

public abstract void setActive(boolean active)

getActiveOnViewIds

public abstract java.lang.String getActiveOnViewIds()
A comma separated list of viewIds for which this item should be active.


getExternalLink

public abstract java.lang.String getExternalLink()
The external link where to redirect when this is clicked.


isRendered

public boolean isRendered()
Overrides:
isRendered in class AbstractHtmlCommandLink
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


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