org.apache.myfaces.custom.navigation
Class AbstractHtmlPanelNavigation

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIPanel
              javax.faces.component.html.HtmlPanelGroup
                  org.apache.myfaces.component.html.ext.AbstractHtmlPanelGroup
                      org.apache.myfaces.component.html.ext.HtmlPanelGroup
                          org.apache.myfaces.custom.navigation.AbstractHtmlPanelNavigation

All Implemented Interfaces:

javax.faces.component.StateHolder, AlignProperty, DataProperties, DisplayValueOnlyAware, EventAware, ForceIdAware, PanelProperties, UniversalProperties, UserRoleAware, org.apache.myfaces.shared_tomahawk.component.DisplayValueOnlyCapable

public abstract class AbstractHtmlPanelNavigation
extends org.apache.myfaces.component.html.ext.HtmlPanelGroup
implements AlignProperty, UniversalProperties, EventAware, DataProperties, PanelProperties

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: 691856 $ $Date: 2008-09-03 21:40:30 -0500 (Wed, 03 Sep 2008) $

Author:

Manfred Geiler (latest modification by $Author: lu4242 $)

Field Summary

static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE

Fields inherited from class org.apache.myfaces.component.html.ext.AbstractHtmlPanelGroup

BLOCK_LAYOUT, DEFAULT_COLSPAN

Fields inherited from interface org.apache.myfaces.component.UserRoleAware

ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR

Fields inherited from interface org.apache.myfaces.shared_tomahawk.component.DisplayValueOnlyCapable

DISPLAY_VALUE_ONLY_ATTR, DISPLAY_VALUE_ONLY_STYLE_ATTR, DISPLAY_VALUE_ONLY_STYLE_CLASS_ATTR

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 org.apache.myfaces.component.html.ext.HtmlPanelGroup

getColspan, getDir, getDisplayValueOnly, getDisplayValueOnlyStyle, getDisplayValueOnlyStyleClass, getEnabledOnUserRole, getFamily, getLang, getLayout, getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getTitle, getVisibleOnUserRole, isForceId, isForceIdIndex, restoreState, saveState, setColspan, setDir, setDisplayValueOnly, setDisplayValueOnlyStyle, setDisplayValueOnlyStyleClass, setEnabledOnUserRole, setForceId, setForceIdIndex, setLang, setLayout, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setTitle, setVisibleOnUserRole

Methods inherited from class org.apache.myfaces.component.html.ext.AbstractHtmlPanelGroup

getClientId, isDisplayValueOnly, isRendered, isSetDisplayValueOnly, setDisplayValueOnly

Methods inherited from class javax.faces.component.html.HtmlPanelGroup

getStyle, getStyleClass, setStyle, setStyleClass

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, 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

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

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

public abstract String getItemClass()

The CSS class of closed navigation items.

getOpenItemClass

public abstract String getOpenItemClass()

The CSS class of open navigation items.

getActiveItemClass

public abstract String getActiveItemClass()

The CSS class of the active navigation item.

getSeparatorClass

public abstract String getSeparatorClass()

The CSS class for the td element of a separator.

getItemStyle

public abstract String getItemStyle()

The CSS Style of closed navigation items.

getOpenItemStyle

public abstract String getOpenItemStyle()

The CSS Style of open navigation items.

getActiveItemStyle

public abstract String getActiveItemStyle()

The CSS Style of the active navigation item.

getSeparatorStyle

public abstract String getSeparatorStyle()

The CSS Style for the td element of a separator.