|
RichFaces UI Components UI 4.3.0.CR1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIOutput
org.richfaces.component.AbstractPanelMenu
org.richfaces.component.UIPanelMenu
@Generated(value={"RichFaces CDK","4.3.0.CR1"})
public class UIPanelMenu
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.
| Nested Class Summary | |
|---|---|
protected static class |
UIPanelMenu.Properties
|
| Field Summary | |
|---|---|
static String |
COMPONENT_FAMILY
|
static String |
COMPONENT_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 | |
|---|---|
UIPanelMenu()
|
|
| Method Summary | |
|---|---|
String |
getCollapseEvent()
The mouse event used for collapsing. |
String |
getDefaultEventName()
|
Collection<String> |
getEventNames()
|
String |
getExpandEvent()
The mouse event used for expansion. |
String |
getFamily()
|
String |
getGroupClass()
Space-separated list of CSS style class(es) to be applied to panel menu groups |
String |
getGroupDisabledClass()
Space-separated list of CSS style class(es) to be applied to disabled panel menu groups |
org.richfaces.PanelMenuMode |
getGroupMode()
Mode used for expanding/collapsing groups: client (default), ajax, server |
javax.el.MethodExpression |
getItemChangeListener()
Method expression referencing a method that will be called when an ItemChangeEvent has been broadcast for the listener. |
String |
getItemClass()
Space-separated list of CSS style class(es) to be applied to the panel menu items. |
String |
getItemDisabledClass()
Space-separated list of CSS style class(es) to be applied to disables panel menu items. |
org.richfaces.PanelMenuMode |
getItemMode()
The mode user for selecting items: client, ajax (default), server |
String |
getOnclick()
|
String |
getOndblclick()
|
String |
getOnmousedown()
|
String |
getOnmousemove()
|
String |
getOnmouseout()
|
String |
getOnmouseover()
|
String |
getOnmouseup()
|
String |
getStyle()
|
String |
getStyleClass()
|
String |
getTopGroupClass()
Space-separated list of CSS style class(es) to be applied to top-level panel menu groups |
String |
getTopGroupDisabledClass()
Space-separated list of CSS style class(es) to be applied to disabled top-level panel menu groups |
String |
getTopItemClass()
Space-separated list of CSS style class(es) to be applied to top-level panel menu items |
String |
getTopItemDisabledClass()
Space-separated list of CSS style class(es) to be applied to disabled top-level panel menu items |
String |
getWidth()
The width of the panel menu in pixels. |
boolean |
isBubbleSelection()
If true (default), selection of any item of group will cause selection of groups - predecessors - in the hierarchy. |
boolean |
isDisabled()
Disables all panel menu items and groups. |
boolean |
isExpandSingle()
If true (default), only one group can be expanded at the time. |
void |
setBubbleSelection(boolean bubbleSelection)
|
void |
setCollapseEvent(String collapseEvent)
|
void |
setDisabled(boolean disabled)
|
void |
setExpandEvent(String expandEvent)
|
void |
setExpandSingle(boolean expandSingle)
|
void |
setGroupClass(String groupClass)
|
void |
setGroupDisabledClass(String groupDisabledClass)
|
void |
setGroupMode(org.richfaces.PanelMenuMode groupMode)
|
void |
setItemChangeListener(javax.el.MethodExpression itemChangeListener)
|
void |
setItemClass(String itemClass)
|
void |
setItemDisabledClass(String itemDisabledClass)
|
void |
setItemMode(org.richfaces.PanelMenuMode itemMode)
|
void |
setOnclick(String onclick)
|
void |
setOndblclick(String ondblclick)
|
void |
setOnmousedown(String onmousedown)
|
void |
setOnmousemove(String onmousemove)
|
void |
setOnmouseout(String onmouseout)
|
void |
setOnmouseover(String onmouseover)
|
void |
setOnmouseup(String onmouseup)
|
void |
setStyle(String style)
|
void |
setStyleClass(String styleClass)
|
void |
setTopGroupClass(String topGroupClass)
|
void |
setTopGroupDisabledClass(String topGroupDisabledClass)
|
void |
setTopItemClass(String topItemClass)
|
void |
setTopItemDisabledClass(String topItemDisabledClass)
|
void |
setWidth(String width)
|
| Methods inherited from class javax.faces.component.UIOutput |
|---|
clearInitialState, getConverter, getLocalValue, markInitialState, restoreState, saveState, setConverter |
| Methods inherited from class javax.faces.component.UIComponentBase |
|---|
addClientBehavior, addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, 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 |
| Methods inherited from class javax.faces.component.UIComponent |
|---|
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, 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 |
| Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder |
|---|
addClientBehavior, getClientBehaviors |
| Methods inherited from interface org.richfaces.event.ItemChangeSource |
|---|
addItemChangeListener, getItemChangeListeners, removeItemChangeListener |
| Field Detail |
|---|
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
| Constructor Detail |
|---|
public UIPanelMenu()
| Method Detail |
|---|
public String getFamily()
getFamily in class AbstractPanelMenupublic Collection<String> getEventNames()
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHoldergetEventNames in class javax.faces.component.UIComponentBasepublic String getDefaultEventName()
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHoldergetDefaultEventName in class javax.faces.component.UIComponentBasepublic boolean isBubbleSelection()
AbstractPanelMenu
isBubbleSelection in class AbstractPanelMenupublic void setBubbleSelection(boolean bubbleSelection)
public String getCollapseEvent()
AbstractPanelMenu
getCollapseEvent in class AbstractPanelMenupublic void setCollapseEvent(String collapseEvent)
public boolean isDisabled()
AbstractPanelMenu
isDisabled in class AbstractPanelMenupublic void setDisabled(boolean disabled)
public String getExpandEvent()
AbstractPanelMenu
getExpandEvent in class AbstractPanelMenupublic void setExpandEvent(String expandEvent)
public boolean isExpandSingle()
AbstractPanelMenu
isExpandSingle in class AbstractPanelMenupublic void setExpandSingle(boolean expandSingle)
public String getGroupClass()
AbstractPanelMenu
getGroupClass in class AbstractPanelMenupublic void setGroupClass(String groupClass)
public String getGroupDisabledClass()
AbstractPanelMenu
getGroupDisabledClass in class AbstractPanelMenupublic void setGroupDisabledClass(String groupDisabledClass)
public org.richfaces.PanelMenuMode getGroupMode()
AbstractPanelMenu
getGroupMode in class AbstractPanelMenupublic void setGroupMode(org.richfaces.PanelMenuMode groupMode)
public javax.el.MethodExpression getItemChangeListener()
AbstractPanelMenu
getItemChangeListener in class AbstractPanelMenupublic void setItemChangeListener(javax.el.MethodExpression itemChangeListener)
public String getItemClass()
AbstractPanelMenu
getItemClass in class AbstractPanelMenupublic void setItemClass(String itemClass)
public String getItemDisabledClass()
AbstractPanelMenu
getItemDisabledClass in class AbstractPanelMenupublic void setItemDisabledClass(String itemDisabledClass)
public org.richfaces.PanelMenuMode getItemMode()
AbstractPanelMenu
getItemMode in class AbstractPanelMenupublic void setItemMode(org.richfaces.PanelMenuMode itemMode)
public String getOnclick()
getOnclick in class AbstractPanelMenupublic void setOnclick(String onclick)
public String getOndblclick()
getOndblclick in class AbstractPanelMenupublic void setOndblclick(String ondblclick)
public String getOnmousedown()
getOnmousedown in class AbstractPanelMenupublic void setOnmousedown(String onmousedown)
public String getOnmousemove()
getOnmousemove in class AbstractPanelMenupublic void setOnmousemove(String onmousemove)
public String getOnmouseout()
getOnmouseout in class AbstractPanelMenupublic void setOnmouseout(String onmouseout)
public String getOnmouseover()
getOnmouseover in class AbstractPanelMenupublic void setOnmouseover(String onmouseover)
public String getOnmouseup()
getOnmouseup in class AbstractPanelMenupublic void setOnmouseup(String onmouseup)
public String getStyle()
getStyle in class AbstractPanelMenupublic void setStyle(String style)
public String getStyleClass()
getStyleClass in class AbstractPanelMenupublic void setStyleClass(String styleClass)
public String getTopGroupClass()
AbstractPanelMenu
getTopGroupClass in class AbstractPanelMenupublic void setTopGroupClass(String topGroupClass)
public String getTopGroupDisabledClass()
AbstractPanelMenu
getTopGroupDisabledClass in class AbstractPanelMenupublic void setTopGroupDisabledClass(String topGroupDisabledClass)
public String getTopItemClass()
AbstractPanelMenu
getTopItemClass in class AbstractPanelMenupublic void setTopItemClass(String topItemClass)
public String getTopItemDisabledClass()
AbstractPanelMenu
getTopItemDisabledClass in class AbstractPanelMenupublic void setTopItemDisabledClass(String topItemDisabledClass)
public String getWidth()
AbstractPanelMenu
getWidth in class AbstractPanelMenupublic void setWidth(String width)
|
RichFaces UI Components UI 4.3.0.CR1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||