public abstract class AbstractPanelMenu
extends javax.faces.component.UIOutput
implements org.richfaces.event.ItemChangeSource
The <rich:panelMenu> component is used in conjunction with <rich:panelMenuItem> and <rich:panelMenuGroup> to create an expanding, hierarchical menu. The <rich:panelMenu> component's appearance can be highly customized, and the hierarchy can stretch to any number of sub-levels.
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
Modifier | Constructor and Description |
---|---|
protected |
AbstractPanelMenu() |
Modifier and Type | Method and Description |
---|---|
void |
addItemChangeListener(org.richfaces.event.ItemChangeListener listener) |
void |
broadcast(javax.faces.event.FacesEvent event) |
String |
getActiveItem()
Holds the active panel name.
|
abstract String |
getCollapseEvent()
The mouse event used for collapsing.
|
abstract String |
getExpandEvent()
The mouse event used for expansion.
|
String |
getFamily() |
abstract String |
getGroupClass()
Space-separated list of CSS style class(es) to be applied to panel menu groups
|
String |
getGroupCollapsedLeftIcon()
The left icon for collapsed panel menu groups
|
String |
getGroupCollapsedRightIcon()
The right icon for collapsed panel menu groups
|
abstract String |
getGroupDisabledClass()
Space-separated list of CSS style class(es) to be applied to disabled panel menu groups
|
String |
getGroupDisabledLeftIcon()
The left icon for disabled panel menu groups
|
String |
getGroupDisabledRightIcon()
The right icon for disabled panel menu groups
|
String |
getGroupExpandedLeftIcon()
The left icon for expanded panel menu groups
|
String |
getGroupExpandedRightIcon()
The right icon for expanded panel menu groups
|
abstract org.richfaces.PanelMenuMode |
getGroupMode()
Mode used for expanding/collapsing groups: client (default), ajax, server
|
AbstractPanelMenuItem |
getItem(String itemName) |
abstract javax.el.MethodExpression |
getItemChangeListener()
Method expression referencing a method that will be called when an ItemChangeEvent has been broadcast for the listener.
|
org.richfaces.event.ItemChangeListener[] |
getItemChangeListeners() |
abstract String |
getItemClass()
Space-separated list of CSS style class(es) to be applied to the panel menu items.
|
abstract String |
getItemDisabledClass()
Space-separated list of CSS style class(es) to be applied to disables panel menu items.
|
String |
getItemDisabledLeftIcon()
The left icon for disabled panel menu items
|
String |
getItemDisabledRightIcon()
The right icon for panel menu items
|
String |
getItemLeftIcon()
The left icon for panel menu items
|
abstract org.richfaces.PanelMenuMode |
getItemMode()
The mode user for selecting items: client, ajax (default), server
|
String |
getItemRightIcon()
The left icon for right menu items
|
abstract String |
getOnclick() |
abstract String |
getOndblclick() |
abstract String |
getOnmousedown() |
abstract String |
getOnmousemove() |
abstract String |
getOnmouseout() |
abstract String |
getOnmouseover() |
abstract String |
getOnmouseup() |
abstract String |
getStyle() |
abstract String |
getStyleClass() |
String |
getSubmittedActiveItem() |
abstract String |
getTopGroupClass()
Space-separated list of CSS style class(es) to be applied to top-level panel menu groups
|
String |
getTopGroupCollapsedLeftIcon()
The left icon for collapsed top-level panel menu groups
|
String |
getTopGroupCollapsedRightIcon()
The right icon for collapsed top-level panel menu groups
|
abstract String |
getTopGroupDisabledClass()
Space-separated list of CSS style class(es) to be applied to disabled top-level panel menu groups
|
String |
getTopGroupDisabledLeftIcon()
The left icon for disabled top-level panel menu groups
|
String |
getTopGroupDisabledRightIcon()
The right icon for disabled top-level panel menu groups
|
String |
getTopGroupExpandedLeftIcon()
The left icon for expanded top-level panel menu groups
|
String |
getTopGroupExpandedRightIcon()
The right icon for expanded top-level panel menu groups
|
abstract String |
getTopItemClass()
Space-separated list of CSS style class(es) to be applied to top-level panel menu items
|
abstract String |
getTopItemDisabledClass()
Space-separated list of CSS style class(es) to be applied to disabled top-level panel menu items
|
String |
getTopItemDisabledLeftIcon()
The left icon for disabled top-level panel menu items
|
String |
getTopItemDisabledRightIcon()
The right icon for disabled top-level panel menu items
|
String |
getTopItemLeftIcon()
The left icon for top-level panel menu items
|
String |
getTopItemRightIcon()
The right icon for top-level panel menu items
|
Object |
getValue() |
abstract String |
getWidth()
The width of the panel menu in pixels.
|
abstract boolean |
isBubbleSelection()
If true (default), selection of any item of group will cause selection of groups - predecessors - in the hierarchy.
|
abstract boolean |
isDisabled()
Disables all panel menu items and groups.
|
abstract boolean |
isExpandSingle()
If true (default), only one group can be expanded at the time.
|
boolean |
isImmediate() |
void |
processDecodes(javax.faces.context.FacesContext context) |
void |
queueEvent(javax.faces.event.FacesEvent event) |
void |
removeItemChangeListener(org.richfaces.event.ItemChangeListener listener) |
void |
setActiveItem(String value) |
void |
setEventPhase(javax.faces.event.FacesEvent event) |
void |
setGroupCollapsedLeftIcon(String groupCollapsedLeftIcon) |
void |
setGroupCollapsedRightIcon(String groupCollapsedRightIcon) |
void |
setGroupDisabledLeftIcon(String groupDisabledLeftIcon) |
void |
setGroupDisabledRightIcon(String groupDisabledRightIcon) |
void |
setGroupExpandedLeftIcon(String groupExpandedLeftIcon) |
void |
setGroupExpandedRightIcon(String groupExpandedRightIcon) |
void |
setImmediate(boolean immediate) |
void |
setItemDisabledLeftIcon(String itemDisabledLeftIcon) |
void |
setItemDisabledRightIcon(String itemDisabledRightIcon) |
void |
setItemLeftIcon(String itemLeftIcon) |
void |
setItemRightIcon(String itemRightIcon) |
void |
setSubmittedActiveItem(String submittedValue) |
void |
setTopGroupCollapsedLeftIcon(String topGroupCollapsedLeftIcon) |
void |
setTopGroupCollapsedRightIcon(String topGroupCollapsedRightIcon) |
void |
setTopGroupDisabledLeftIcon(String topGroupDisabledLeftIcon) |
void |
setTopGroupDisabledRightIcon(String topGroupDisabledRightIcon) |
void |
setTopGroupExpandedLeftIcon(String topGroupExpandedLeftIcon) |
void |
setTopGroupExpandedRightIcon(String topGroupExpandedRightIcon) |
void |
setTopItemDisabledLeftIcon(String topItemDisabledLeftIcon) |
void |
setTopItemDisabledRightIcon(String topItemDisabledRightIcon) |
void |
setTopItemLeftIcon(String topItemLeftIcon) |
void |
setTopItemRightIcon(String topItemRightIcon) |
void |
setValue(Object value) |
void |
setValueExpression(String name,
javax.el.ValueExpression binding) |
clearInitialState, getConverter, getLocalValue, markInitialState, restoreState, saveState, setConverter
addClientBehavior, addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTree
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public void processDecodes(javax.faces.context.FacesContext context)
processDecodes
in class javax.faces.component.UIComponentBase
public void queueEvent(javax.faces.event.FacesEvent event)
queueEvent
in class javax.faces.component.UIComponentBase
public void setEventPhase(javax.faces.event.FacesEvent event)
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class javax.faces.component.UIComponentBase
javax.faces.event.AbortProcessingException
public String getSubmittedActiveItem()
public void setSubmittedActiveItem(String submittedValue)
public String getActiveItem()
public void setActiveItem(String value)
public void setValueExpression(String name, javax.el.ValueExpression binding)
setValueExpression
in class javax.faces.component.UIComponent
public boolean isImmediate()
public void setImmediate(boolean immediate)
public String getFamily()
getFamily
in class javax.faces.component.UIOutput
public abstract boolean isDisabled()
public abstract String getExpandEvent()
public abstract String getCollapseEvent()
public abstract org.richfaces.PanelMenuMode getGroupMode()
public abstract boolean isExpandSingle()
public abstract org.richfaces.PanelMenuMode getItemMode()
public abstract boolean isBubbleSelection()
public abstract javax.el.MethodExpression getItemChangeListener()
public abstract String getStyle()
public abstract String getStyleClass()
public abstract String getWidth()
public abstract String getItemClass()
public abstract String getItemDisabledClass()
public String getItemLeftIcon()
public void setItemLeftIcon(String itemLeftIcon)
public String getItemRightIcon()
public void setItemRightIcon(String itemRightIcon)
public String getItemDisabledLeftIcon()
public void setItemDisabledLeftIcon(String itemDisabledLeftIcon)
public String getItemDisabledRightIcon()
public void setItemDisabledRightIcon(String itemDisabledRightIcon)
public abstract String getTopItemClass()
public abstract String getTopItemDisabledClass()
public String getTopItemLeftIcon()
public void setTopItemLeftIcon(String topItemLeftIcon)
public String getTopItemRightIcon()
public void setTopItemRightIcon(String topItemRightIcon)
public String getTopItemDisabledLeftIcon()
public void setTopItemDisabledLeftIcon(String topItemDisabledLeftIcon)
public String getTopItemDisabledRightIcon()
public void setTopItemDisabledRightIcon(String topItemDisabledRightIcon)
public abstract String getGroupClass()
public abstract String getGroupDisabledClass()
public String getGroupExpandedLeftIcon()
public void setGroupExpandedLeftIcon(String groupExpandedLeftIcon)
public String getGroupExpandedRightIcon()
public void setGroupExpandedRightIcon(String groupExpandedRightIcon)
public String getGroupCollapsedLeftIcon()
public void setGroupCollapsedLeftIcon(String groupCollapsedLeftIcon)
public String getGroupCollapsedRightIcon()
public void setGroupCollapsedRightIcon(String groupCollapsedRightIcon)
public String getGroupDisabledLeftIcon()
public void setGroupDisabledLeftIcon(String groupDisabledLeftIcon)
public String getGroupDisabledRightIcon()
public void setGroupDisabledRightIcon(String groupDisabledRightIcon)
public abstract String getTopGroupClass()
public abstract String getTopGroupDisabledClass()
public String getTopGroupExpandedLeftIcon()
public void setTopGroupExpandedLeftIcon(String topGroupExpandedLeftIcon)
public String getTopGroupExpandedRightIcon()
public void setTopGroupExpandedRightIcon(String topGroupExpandedRightIcon)
public String getTopGroupCollapsedLeftIcon()
public void setTopGroupCollapsedLeftIcon(String topGroupCollapsedLeftIcon)
public String getTopGroupCollapsedRightIcon()
public void setTopGroupCollapsedRightIcon(String topGroupCollapsedRightIcon)
public String getTopGroupDisabledLeftIcon()
public void setTopGroupDisabledLeftIcon(String topGroupDisabledLeftIcon)
public String getTopGroupDisabledRightIcon()
public void setTopGroupDisabledRightIcon(String topGroupDisabledRightIcon)
public abstract String getOnclick()
public abstract String getOndblclick()
public abstract String getOnmousedown()
public abstract String getOnmousemove()
public abstract String getOnmouseout()
public abstract String getOnmouseover()
public abstract String getOnmouseup()
public AbstractPanelMenuItem getItem(String itemName)
public void addItemChangeListener(org.richfaces.event.ItemChangeListener listener)
addItemChangeListener
in interface org.richfaces.event.ItemChangeSource
public org.richfaces.event.ItemChangeListener[] getItemChangeListeners()
getItemChangeListeners
in interface org.richfaces.event.ItemChangeSource
public void removeItemChangeListener(org.richfaces.event.ItemChangeListener listener)
removeItemChangeListener
in interface org.richfaces.event.ItemChangeSource
public Object getValue()
getValue
in interface javax.faces.component.ValueHolder
getValue
in class javax.faces.component.UIOutput
public void setValue(Object value)
setValue
in interface javax.faces.component.ValueHolder
setValue
in class javax.faces.component.UIOutput
Copyright © 2014 JBoss by Red Hat. All Rights Reserved.