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

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.navmenu.htmlnavmenu.AbstractHtmlPanelNavigationMenu

All Implemented Interfaces:

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

public abstract class AbstractHtmlPanelNavigationMenu
extends org.apache.myfaces.component.html.ext.HtmlPanelGroup
implements javax.faces.component.NamingContainer, UniversalProperties, EventAware, PanelProperties, AlignProperty, DataProperties

Renders a vertical menu structure with support for nested menu items. The menu is rendered as unordered List. The menu-tree can be dynamically build using NavigationMenuItem(s). 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 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 javax.faces.component.NamingContainer

SEPARATOR_CHAR

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

AbstractHtmlPanelNavigationMenu()

Method Summary

void	decode(javax.faces.context.FacesContext context)
void	encodeBegin(javax.faces.context.FacesContext context)
abstract String	getActiveItemClass() The CSS class of open navigation items.
abstract String	getActiveItemStyle() The CSS Style of the active navigation item.
abstract String	getDisabledStyle() CSS-Style Attribute to render when disabled is true
abstract String	getDisabledStyleClass() CSS-Style Class to use when disabled is true
abstract String	getItemClass() The CSS class of closed navigation items.
abstract String	getItemStyle() The CSS Style of closed navigation items.
abstract String	getLayout() 'table' or 'list' Layout (default is 'table')
abstract String	getOpenItemClass() The CSS class of open navigation items.
abstract String	getOpenItemStyle() The CSS Style of open navigation items.
abstract Boolean	getPreprocessed()
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.
abstract boolean	isDisabled() When set instead of a Hyperlink a span tag is rendered in the corresponding Component
abstract boolean	isExpandAll() If set to true all Items are expanded from the beginning and never closed.
abstract boolean	isRenderAll() If set to true all Items are rendered and other methods, like CSS should be used to hide them as necessary
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, 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.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.PanelProperties

getBgcolor, getBorder, getCellpadding, getCellspacing, getFrame, getRules, getSummary, getWidth

Methods inherited from interface org.apache.myfaces.component.AlignProperty

getAlign

Methods inherited from interface org.apache.myfaces.component.DataProperties

getDatafld, getDataformatas, getDatasrc

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

AbstractHtmlPanelNavigationMenu

public AbstractHtmlPanelNavigationMenu()

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 open navigation items.

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.

getLayout

public abstract String getLayout()

'table' or 'list' Layout (default is 'table')

Overrides:

getLayout in class org.apache.myfaces.component.html.ext.HtmlPanelGroup

getPreprocessed

public abstract Boolean getPreprocessed()

isExpandAll

public abstract boolean isExpandAll()

If set to true all Items are expanded from the beginning and never closed.

isRenderAll

public abstract boolean isRenderAll()

If set to true all Items are rendered and other methods, like CSS should be used to hide them as necessary

isDisabled

public abstract boolean isDisabled()

When set instead of a Hyperlink a span tag is rendered in the corresponding Component

getDisabledStyle

public abstract String getDisabledStyle()

CSS-Style Attribute to render when disabled is true

getDisabledStyleClass

public abstract String getDisabledStyleClass()

CSS-Style Class to use when disabled is true