org.apache.myfaces.custom.navigation
Class AbstractHtmlCommandNavigation

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.navigation.AbstractHtmlCommandNavigation
All Implemented Interfaces:
java.util.EventListener, javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, ForceIdAware, UserRoleAware
Direct Known Subclasses:
HtmlCommandNavigation

public abstract class AbstractHtmlCommandNavigation
extends HtmlCommandLink

Command, that represents a navigation item. 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.

Since:
1.1.7
Version:
$Revision: 1001029 $ $Date: 2010-09-24 13:57:00 -0500 (Fri, 24 Sep 2010) $
Author:
Manfred Geiler (latest modification by $Author: lu4242 $)

Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.myfaces.component.html.ext.HtmlCommandLink
HtmlCommandLink.PropertyKeys
 
Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
 
Fields inherited from class javax.faces.component.UIComponent
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
 
Fields inherited from interface org.apache.myfaces.component.UserRoleAware
ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR
 
Constructor Summary
AbstractHtmlCommandNavigation()
           
 
Method Summary
 void broadcast(javax.faces.event.FacesEvent event)
           
 java.lang.Boolean getActiveDirectly()
           
 java.lang.Boolean getOpenDirectly()
           
abstract  boolean isActive()
           
 boolean isImmediate()
           
abstract  boolean isOpen()
           
 boolean isRendered()
           
abstract  void setActive(boolean active)
           
 void setImmediate(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, 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, getDefaultEventName, getDir, getEventNames, 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, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors
 

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

AbstractHtmlCommandNavigation

public AbstractHtmlCommandNavigation()
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(boolean immediate)
Specified by:
setImmediate in interface javax.faces.component.ActionSource
Overrides:
setImmediate in class javax.faces.component.UICommand

getOpenDirectly

public java.lang.Boolean getOpenDirectly()

getActiveDirectly

public java.lang.Boolean getActiveDirectly()

isRendered

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

isOpen

public abstract boolean isOpen()

setOpen

public abstract void setOpen(boolean open)

isActive

public abstract boolean isActive()

setActive

public abstract void setActive(boolean active)

toggleOpen

public void toggleOpen()

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.