org.apache.myfaces.custom.navigation
Class AbstractHtmlPanelNavigation

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIPanel
              extended by javax.faces.component.html.HtmlPanelGroup
                  extended by org.apache.myfaces.custom.navigation.AbstractHtmlPanelNavigation
All Implemented Interfaces:
EventListener, 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, org.apache.myfaces.component.AlignProperty, org.apache.myfaces.component.DataProperties, EventAware, org.apache.myfaces.component.PanelProperties, org.apache.myfaces.component.UniversalProperties

@JSFComponent(name="t:panelNavigation",
              clazz="org.apache.myfaces.custom.navigation.HtmlPanelNavigation",
              tagClass="org.apache.myfaces.custom.navigation.HtmlPanelNavigationTag")
public abstract class AbstractHtmlPanelNavigation
extends javax.faces.component.html.HtmlPanelGroup
implements org.apache.myfaces.component.AlignProperty, org.apache.myfaces.component.UniversalProperties, EventAware, org.apache.myfaces.component.DataProperties, org.apache.myfaces.component.PanelProperties, javax.faces.component.behavior.ClientBehaviorHolder

Renders a vertical menu structure with support for nested menu items. Unless otherwise specified, all attributes accept static values or EL expressions. Panel, that includes navigation items (HtmlCommandNavigation) and other components (separators).

Since:
1.1.7
Version:
$Revision: 691871 $ $Date: 2008-09-03 23:32:08 -0500 (miƩ, 03 sep 2008) $
Author:
Manfred Geiler (latest modification by $Author: lu4242 $)

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.faces.component.html.HtmlPanelGroup
javax.faces.component.html.HtmlPanelGroup.PropertyKeys
 
Field Summary
static String COMPONENT_FAMILY
           
static 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
 
Constructor Summary
AbstractHtmlPanelNavigation()
           
 
Method Summary
 void decode(javax.faces.context.FacesContext context)
           
 void encodeBegin(javax.faces.context.FacesContext context)
           
abstract  String getActiveItemClass()
          The CSS class of the active navigation item.
abstract  String getActiveItemStyle()
          The CSS Style of the active navigation item.
abstract  String getItemClass()
          The CSS class of closed navigation items.
abstract  String getItemStyle()
          The CSS Style of closed navigation items.
abstract  String getOpenItemClass()
          The CSS class of open navigation items.
abstract  String getOpenItemStyle()
          The CSS Style of open navigation items.
abstract  String getSeparatorClass()
          The CSS class for the td element of a separator.
abstract  String getSeparatorStyle()
          The CSS Style for the td element of a separator.
 void restoreOpenActiveStates(javax.faces.context.FacesContext facesContext, javax.faces.component.UIViewRoot previousRoot, List children)
           
 
Methods inherited from class javax.faces.component.html.HtmlPanelGroup
getFamily, getLayout, getStyle, getStyleClass, setLayout, setStyle, setStyleClass, setValueBinding, setValueExpression
 
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, encodeAll, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, visitTree
 
Methods inherited from class javax.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, subscribeToEvent, unsubscribeFromEvent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.myfaces.component.AlignProperty
getAlign
 
Methods inherited from interface org.apache.myfaces.component.UniversalProperties
getDir, getLang, getTitle
 
Methods inherited from interface org.apache.myfaces.component.EventAware
getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup
 
Methods inherited from interface org.apache.myfaces.component.DataProperties
getDatafld, getDataformatas, getDatasrc
 
Methods inherited from interface org.apache.myfaces.component.PanelProperties
getBgcolor, getBorder, getCellpadding, getCellspacing, getFrame, getRules, getSummary, getWidth
 
Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames
 

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values

COMPONENT_FAMILY

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

AbstractHtmlPanelNavigation

public AbstractHtmlPanelNavigation()
Method Detail

decode

public void decode(javax.faces.context.FacesContext context)
Overrides:
decode in class javax.faces.component.UIComponentBase

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws IOException
Overrides:
encodeBegin in class javax.faces.component.UIComponentBase
Throws:
IOException

restoreOpenActiveStates

public void restoreOpenActiveStates(javax.faces.context.FacesContext facesContext,
                                    javax.faces.component.UIViewRoot previousRoot,
                                    List children)

getItemClass

@JSFProperty
public abstract String getItemClass()
The CSS class of closed navigation items.


getOpenItemClass

@JSFProperty
public abstract String getOpenItemClass()
The CSS class of open navigation items.


getActiveItemClass

@JSFProperty
public abstract String getActiveItemClass()
The CSS class of the active navigation item.


getSeparatorClass

@JSFProperty
public abstract String getSeparatorClass()
The CSS class for the td element of a separator.


getItemStyle

@JSFProperty
public abstract String getItemStyle()
The CSS Style of closed navigation items.


getOpenItemStyle

@JSFProperty
public abstract String getOpenItemStyle()
The CSS Style of open navigation items.


getActiveItemStyle

@JSFProperty
public abstract String getActiveItemStyle()
The CSS Style of the active navigation item.


getSeparatorStyle

@JSFProperty
public abstract String getSeparatorStyle()
The CSS Style for the td element of a separator.



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