public abstract class AbstractPanelMenu extends javax.faces.component.UIOutput implements ItemChangeSource, EventsMouseProps, ImmediateProps, StyleProps, StyleClassProps
The <r:panelMenu> component is used in conjunction with <r:panelMenuItem> and <r:panelMenuGroup> to create an expanding, hierarchical menu. The <r: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(ItemChangeListener listener)
Add a new
ItemChangeListener to the set of listeners interested in being notified when
ItemChangeEvents occur. |
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 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.
|
ItemChangeListener[] |
getItemChangeListeners()
Return the set of registered
ItemChangeListeners for this instance. |
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 PanelMenuMode |
getItemMode()
The mode user for selecting items: client, ajax (default), server
|
String |
getItemRightIcon()
The left icon for right menu items
|
abstract String |
getOnclick()
Javascript code executed when a pointer button is clicked over this element.
|
abstract String |
getOndblclick()
Javascript code executed when a pointer button is double clicked over this element.
|
abstract String |
getOnmousedown()
Javascript code executed when a pointer button is pressed down over this element.
|
abstract String |
getOnmousemove()
Javascript code executed when a pointer button is moved within this element.
|
abstract String |
getOnmouseout()
Javascript code executed when a pointer button is moved away from this element.
|
abstract String |
getOnmouseover()
Javascript code executed when a pointer button is moved onto this element.
|
abstract String |
getOnmouseup()
Javascript code executed when a pointer button is released over this element.
|
abstract String |
getStyle()
CSS style(s) to be applied when this component is rendered.
|
abstract String |
getStyleClass()
Space-separated list of CSS style class(es) to be applied when this element is rendered.
|
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()
Flag indicating that, if this component is activated by the user, notifications should be delivered to interested
listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until the
Invoke Application phase.
|
void |
processDecodes(javax.faces.context.FacesContext context) |
void |
queueEvent(javax.faces.event.FacesEvent event) |
void |
removeItemChangeListener(ItemChangeListener listener)
Remove an existing
ItemChangeListener (if any) from the set of listeners interested in being
notified when ItemChangeEvents occur. |
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, resetValue, restoreState, saveState, setConverteraddClientBehavior, addFacesListener, 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, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEventencodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTreepublic 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.UIComponentBasepublic void queueEvent(javax.faces.event.FacesEvent event)
queueEvent in class javax.faces.component.UIComponentBasepublic 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.UIComponentBasejavax.faces.event.AbortProcessingExceptionpublic 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.UIComponentpublic boolean isImmediate()
ImmediatePropsisImmediate in interface ImmediatePropspublic void setImmediate(boolean immediate)
public String getFamily()
getFamily in class javax.faces.component.UIOutputpublic abstract boolean isDisabled()
public abstract String getExpandEvent()
public abstract String getCollapseEvent()
public abstract PanelMenuMode getGroupMode()
public abstract boolean isExpandSingle()
public abstract PanelMenuMode getItemMode()
public abstract boolean isBubbleSelection()
public abstract javax.el.MethodExpression getItemChangeListener()
public abstract String getStyle()
StylePropsgetStyle in interface StylePropspublic abstract String getStyleClass()
StyleClassPropsgetStyleClass in interface StyleClassPropspublic 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()
EventsMousePropsgetOnclick in interface EventsMousePropspublic abstract String getOndblclick()
EventsMousePropsgetOndblclick in interface EventsMousePropspublic abstract String getOnmousedown()
EventsMousePropsgetOnmousedown in interface EventsMousePropspublic abstract String getOnmousemove()
EventsMousePropsgetOnmousemove in interface EventsMousePropspublic abstract String getOnmouseout()
EventsMousePropsgetOnmouseout in interface EventsMousePropspublic abstract String getOnmouseover()
EventsMousePropsgetOnmouseover in interface EventsMousePropspublic abstract String getOnmouseup()
EventsMousePropsgetOnmouseup in interface EventsMousePropspublic AbstractPanelMenuItem getItem(String itemName)
public void addItemChangeListener(ItemChangeListener listener)
ItemChangeSource
Add a new ItemChangeListener to the set of listeners interested in being notified when
ItemChangeEvents occur.
addItemChangeListener in interface ItemChangeSourcelistener - The ItemChangeListener to be addedpublic ItemChangeListener[] getItemChangeListeners()
ItemChangeSource
Return the set of registered ItemChangeListeners for this instance. If there are no
registered listeners, a zero-length array is returned.
getItemChangeListeners in interface ItemChangeSourcepublic void removeItemChangeListener(ItemChangeListener listener)
ItemChangeSource
Remove an existing ItemChangeListener (if any) from the set of listeners interested in being
notified when ItemChangeEvents occur.
removeItemChangeListener in interface ItemChangeSourcelistener - The ItemChangeListener to be removedpublic Object getValue()
getValue in interface javax.faces.component.ValueHoldergetValue in class javax.faces.component.UIOutputpublic void setValue(Object value)
setValue in interface javax.faces.component.ValueHoldersetValue in class javax.faces.component.UIOutputCopyright © 2014 JBoss by Red Hat. All rights reserved.