org.icefaces.ace.component.breadcrumbmenu

Class BreadcrumbMenuBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.icefaces.ace.component.menu.AbstractMenu

org.icefaces.ace.component.breadcrumbmenu.BreadcrumbMenuBase

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, IBreadcrumbMenu

Direct Known Subclasses:

BreadcrumbMenu

public abstract class BreadcrumbMenuBase
extends AbstractMenu
implements IBreadcrumbMenu

BreadcrumbMenu is a horizontal bar of breadcrumb menu items. The crumbs are encoded by child menuItem tags. The menu items can be encoded inline or dynamically using a menu model (org.icefaces.ace.model.MenuModel). The icon attribute is not used. The icon will be forced to a home page icon for the first item and a right arrow icon for the rest. The last (or only) item will also be forced to be disabled.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	BreadcrumbMenuBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_TYPE
static java.lang.String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
BreadcrumbMenuBase()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAccesskey() Return the value of the accesskey property.
java.lang.String	getFamily()
MenuModel	getModel() Return the value of the model property.
java.lang.String	getStyle() Return the value of the style property.
java.lang.String	getStyleClass() Return the value of the styleClass property.
protected boolean	isPropertySet(java.lang.String finder)
void	setAccesskey(java.lang.String accesskey) Set the value of the accesskey property.
void	setModel(MenuModel model) Set the value of the model property.
void	setStyle(java.lang.String style) Set the value of the style property.
void	setStyleClass(java.lang.String styleClass) Set the value of the styleClass property.
void	setValueExpression(java.lang.String name, javax.el.ValueExpression binding)

Methods inherited from class org.icefaces.ace.component.menu.AbstractMenu

buildMenuFromModel, isBuiltFromModel, isDynamic, markAsBuiltFromModel, processDecodes, setTransientRecursive, shouldBuildFromModel

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTree

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

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

BreadcrumbMenuBase

public BreadcrumbMenuBase()

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

setAccesskey

public void setAccesskey(java.lang.String accesskey)

Set the value of the accesskey property.

Contents: Access key that, when pressed, transfers focus to the first focusable item in the menu. This accesskey value overrides any possible accesskey value that the menu item itself could have.

Specified by:

setAccesskey in interface IBreadcrumbMenu

getAccesskey

public java.lang.String getAccesskey()

Return the value of the accesskey property.

Contents: Access key that, when pressed, transfers focus to the first focusable item in the menu. This accesskey value overrides any possible accesskey value that the menu item itself could have.

Specified by:

getAccesskey in interface IBreadcrumbMenu

setModel

public void setModel(MenuModel model)

Set the value of the model property.

Contents: MenuModel instance to create menus programmatically. For the menuitem components, use explicit ids, and avoid long processing in the getter method for this property, as it will be called multiple times, in every lifecycle.

Specified by:

setModel in interface IBreadcrumbMenu

getModel

public MenuModel getModel()

Return the value of the model property.

Contents: MenuModel instance to create menus programmatically. For the menuitem components, use explicit ids, and avoid long processing in the getter method for this property, as it will be called multiple times, in every lifecycle.

Specified by:

getModel in interface IBreadcrumbMenu

Specified by:

getModel in class AbstractMenu

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

Contents: Style of the main container element.

Specified by:

setStyle in interface IBreadcrumbMenu

getStyle

public java.lang.String getStyle()

Return the value of the style property.

Contents: Style of the main container element.

Specified by:

getStyle in interface IBreadcrumbMenu

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

Contents: Style class of the main container element.

Specified by:

setStyleClass in interface IBreadcrumbMenu

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property.

Contents: Style class of the main container element.

Specified by:

getStyleClass in interface IBreadcrumbMenu

isPropertySet

protected boolean isPropertySet(java.lang.String finder)

setValueExpression

public void setValueExpression(java.lang.String name,
                      javax.el.ValueExpression binding)

Overrides:

setValueExpression in class javax.faces.component.UIComponent