Package org.primefaces.component.dock

Class DockBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIPanel

org.primefaces.component.menu.AbstractMenu

org.primefaces.component.dock.DockBase

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

Direct Known Subclasses:

Dock

public abstract class DockBase
extends AbstractMenu
implements Widget

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DockBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT_FAMILY
static final String	DEFAULT_RENDERER

Fields inherited from class org.primefaces.component.menu.AbstractMenu

END_CLASS, LIST_CLASS, MENU_RTL_CLASS, MENUITEM_CLASS, MENUITEM_ICON_CLASS, MENUITEM_LINK_CLASS, MENUITEM_TEXT_CLASS, OPTIONS_CLASS, START_CLASS, SUBMENU_DOWN_ICON_CLASS, SUBMENU_LEFT_ICON_CLASS, SUBMENU_LINK_CLASS, SUBMENU_RIGHT_ICON_CLASS, TIERED_CHILD_SUBMENU_CLASS, TIERED_SUBMENU_CLASS

Fields inherited from class javax.faces.component.UIPanel

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

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

ATTR_WIDGET_VAR_PATTERN, CALLBACK_POST_CONSTRUCT, CALLBACK_POST_REFRESH, CALLBACK_PRE_DESTROY

Constructor Summary

Constructors

Constructor	Description
DockBase()

Method Summary

Modifier and Type	Method	Description
int	getAnimationDuration()
String	getFamily()
String	getHalign()
MenuModel	getModel()
String	getPosition()
String	getWidgetVar()
boolean	isAnimate()
boolean	isBlockScroll()
void	setAnimate(boolean animate)
void	setAnimationDuration(int animationDuration)
void	setBlockScroll(boolean blockScroll)
void	setHalign(String halign)
void	setModel(MenuModel model)
void	setPosition(String position)
void	setWidgetVar(String widgetVar)

Methods inherited from class org.primefaces.component.menu.AbstractMenu

broadcast, getDir, getElements, getElementsCount, getHideDelay, getShowDelay, getTabindex, getToggleEvent, isAutoDisplay, isDynamic, setAutoDisplay, setDir, setHideDelay, setShowDelay, setTabindex, setToggleEvent

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

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

resolveWidgetVar, resolveWidgetVar

Field Details

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

• Constant Field Values

DEFAULT_RENDERER

public static final String DEFAULT_RENDERER

See Also:

• Constant Field Values

Constructor Details

DockBase

public DockBase()

Method Details

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIPanel

getWidgetVar

public String getWidgetVar()

setWidgetVar

public void setWidgetVar(String widgetVar)

getModel

public MenuModel getModel()

Specified by:

getModel in class AbstractMenu

setModel

public void setModel(MenuModel model)

getPosition

public String getPosition()

setPosition

public void setPosition(String position)

getHalign

public String getHalign()

setHalign

public void setHalign(String halign)

isBlockScroll

public boolean isBlockScroll()

setBlockScroll

public void setBlockScroll(boolean blockScroll)

isAnimate

public boolean isAnimate()

setAnimate

public void setAnimate(boolean animate)

getAnimationDuration

public int getAnimationDuration()

setAnimationDuration

public void setAnimationDuration(int animationDuration)