Package org.primefaces.component.menu

Class AbstractMenu

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIPanel

org.primefaces.component.menu.AbstractMenu

All Implemented Interfaces:

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, MenuItemAware, RTLAware

Direct Known Subclasses:

BreadCrumbBase, ContextMenuBase, DockBase, MegaMenuBase, MenubarBase, MenuBase, MenuButtonBase, PanelMenuBase, SlideMenuBase, SpeedDialBase, StackBase, StepsBase, TabMenuBase, TieredMenuBase

public abstract class AbstractMenu
extends javax.faces.component.UIPanel
implements MenuItemAware, RTLAware

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AbstractMenu.PropertyKeys

Field Summary

Fields

Modifier and Type	Field	Description
static final String	END_CLASS
static final String	LIST_CLASS
static final String	MENU_RTL_CLASS
static final String	MENUITEM_CLASS
static final String	MENUITEM_ICON_CLASS
static final String	MENUITEM_LINK_CLASS
static final String	MENUITEM_TEXT_CLASS
static final String	OPTIONS_CLASS
static final String	START_CLASS
static final String	SUBMENU_DOWN_ICON_CLASS
static final String	SUBMENU_LEFT_ICON_CLASS
static final String	SUBMENU_LINK_CLASS
static final String	SUBMENU_RIGHT_ICON_CLASS
static final String	TIERED_CHILD_SUBMENU_CLASS
static final String	TIERED_SUBMENU_CLASS

Fields inherited from class javax.faces.component.UIPanel

COMPONENT_FAMILY, 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

Fields inherited from interface org.primefaces.component.api.MenuItemAware

PARAMS_ACTION_EVENT, PARAMS_EMPTY, PARAMS_MENU_ACTION_EVENT

Constructor Summary

Constructors

Constructor	Description
AbstractMenu()

Method Summary

Modifier and Type	Method	Description
void	broadcast(javax.faces.event.FacesEvent event)
String	getDir()
List<MenuElement>	getElements()
int	getElementsCount()
int	getHideDelay()
abstract MenuModel	getModel()
int	getShowDelay()
String	getTabindex()
String	getToggleEvent()
boolean	isAutoDisplay()
boolean	isDynamic()
void	setAutoDisplay(boolean autoDisplay)
void	setDir(String dir)
void	setHideDelay(int hideDelay)
void	setShowDelay(int showDelay)
void	setTabindex(String tabindex)
void	setToggleEvent(String toggleEvent)

Methods inherited from class javax.faces.component.UIPanel

getFamily

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, 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, processDecodes, 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, setValueExpression, visitTree

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.primefaces.component.api.MenuItemAware

broadcastMenuActionEvent

Methods inherited from interface org.primefaces.component.api.RTLAware

isRTL

Field Details

LIST_CLASS

public static final String LIST_CLASS

See Also:

• Constant Field Values

MENU_RTL_CLASS

public static final String MENU_RTL_CLASS

See Also:

• Constant Field Values

MENUITEM_CLASS

public static final String MENUITEM_CLASS

See Also:

• Constant Field Values

MENUITEM_LINK_CLASS

public static final String MENUITEM_LINK_CLASS

See Also:

• Constant Field Values

MENUITEM_TEXT_CLASS

public static final String MENUITEM_TEXT_CLASS

See Also:

• Constant Field Values

MENUITEM_ICON_CLASS

public static final String MENUITEM_ICON_CLASS

See Also:

• Constant Field Values

TIERED_SUBMENU_CLASS

public static final String TIERED_SUBMENU_CLASS

See Also:

• Constant Field Values

TIERED_CHILD_SUBMENU_CLASS

public static final String TIERED_CHILD_SUBMENU_CLASS

See Also:

• Constant Field Values

SUBMENU_RIGHT_ICON_CLASS

public static final String SUBMENU_RIGHT_ICON_CLASS

See Also:

• Constant Field Values

SUBMENU_LEFT_ICON_CLASS

public static final String SUBMENU_LEFT_ICON_CLASS

See Also:

• Constant Field Values

SUBMENU_DOWN_ICON_CLASS

public static final String SUBMENU_DOWN_ICON_CLASS

See Also:

• Constant Field Values

SUBMENU_LINK_CLASS

public static final String SUBMENU_LINK_CLASS

See Also:

• Constant Field Values

OPTIONS_CLASS

public static final String OPTIONS_CLASS

See Also:

• Constant Field Values

START_CLASS

public static final String START_CLASS

See Also:

• Constant Field Values

END_CLASS

public static final String END_CLASS

See Also:

• Constant Field Values

Constructor Details

AbstractMenu

public AbstractMenu()

Method Details

getTabindex

public String getTabindex()

setTabindex

public void setTabindex(String tabindex)

isAutoDisplay

public boolean isAutoDisplay()

setAutoDisplay

public void setAutoDisplay(boolean autoDisplay)

getShowDelay

public int getShowDelay()

setShowDelay

public void setShowDelay(int showDelay)

getHideDelay

public int getHideDelay()

setHideDelay

public void setHideDelay(int hideDelay)

getToggleEvent

public String getToggleEvent()

setToggleEvent

public void setToggleEvent(String toggleEvent)

getDir

public String getDir()

Specified by:

getDir in interface RTLAware

setDir

public void setDir(String dir)

getElements

public List<MenuElement> getElements()

Specified by:

getElements in interface MenuItemAware

getElementsCount

public int getElementsCount()

getModel

public abstract MenuModel getModel()

isDynamic

public boolean isDynamic()

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Overrides:

broadcast in class javax.faces.component.UIComponentBase

Throws:

javax.faces.event.AbortProcessingException