org.icefaces.ace.component.contextmenu

Class ContextMenuBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.icefaces.ace.component.menu.AbstractMenu

org.icefaces.ace.component.contextmenu.ContextMenuBase

All Implemented Interfaces:

java.util.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, IContextMenu

Direct Known Subclasses:

ContextMenu

public abstract class ContextMenuBase
extends AbstractMenu
implements IContextMenu

ContextMenu provides a popup menu that is displayed on mouse right-click event.

For more information, see the ContextMenu Wiki Documentation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ContextMenuBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_TYPE
static java.lang.String	RENDERER_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

Constructors

Constructor and Description
ContextMenuBase()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDirection() Return the value of the direction property.
java.lang.String	getEffect() Return the value of the effect property.
int	getEffectDuration() Return the value of the effectDuration property.
java.lang.String	getFamily()
javax.el.ValueExpression	getFetch() Return the value of the fetch property.
java.lang.String	getFor() Return the value of the for property.
java.lang.Integer	getForceUpdateCounter() Return the value of the forceUpdateCounter property.
java.lang.String	getForDelegate() Return the value of the forDelegate property.
MenuModel	getModel() Return the value of the model property.
java.lang.Object	getStore() Return the value of the store property.
java.lang.String	getStyle() Return the value of the style property.
java.lang.String	getStyleClass() Return the value of the styleClass property.
java.lang.String	getSubmenuLabels() Return the value of the submenuLabels property.
int	getZindex() Return the value of the zindex property.
java.lang.Boolean	isForceMenuUpdate() Return the value of the forceMenuUpdate property.
protected boolean	isPropertySet(java.lang.String finder)
void	setDirection(java.lang.String direction) Set the value of the direction property.
void	setEffect(java.lang.String effect) Set the value of the effect property.
void	setEffectDuration(int effectDuration) Set the value of the effectDuration property.
void	setFetch(javax.el.ValueExpression fetch) Set the value of the fetch property.
void	setFor(java.lang.String forValue) Set the value of the for property.
void	setForceMenuUpdate(java.lang.Boolean forceMenuUpdate) Set the value of the forceMenuUpdate property.
void	setForceUpdateCounter(java.lang.Integer forceUpdateCounter) Set the value of the forceUpdateCounter property.
void	setForDelegate(java.lang.String forDelegate) Set the value of the forDelegate property.
void	setModel(MenuModel model) Set the value of the model property.
void	setStore(java.lang.Object store) Set the value of the store property.
void	setStyle(java.lang.String style) Set the value of the style property.
void	setStyleClass(java.lang.String styleClass) Set the value of the styleClass property.
void	setSubmenuLabels(java.lang.String submenuLabels) Set the value of the submenuLabels property.
void	setValueExpression(java.lang.String name, javax.el.ValueExpression binding)
void	setZindex(int zindex) Set the value of the zindex property.

Methods inherited from class org.icefaces.ace.component.menu.AbstractMenu

buildMenuFromModel, isBuiltFromModel, isDynamic, markAsBuiltFromModel, processDecodes, setTransientRecursive, shouldBuildFromModel

Methods inherited from class javax.faces.component.UIComponentBase

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

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

ContextMenuBase

public ContextMenuBase()

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

setDirection

public void setDirection(java.lang.String direction)

Set the value of the direction property.

Contents: Forces the direction in which the context menu will be displayed, regardless of the position of the mouse pointer in the viewport. Possible values are combinations of "up" and "down" with "left" and "right", separated by a space, and "auto" can also be used in place of any of those values (e.g. "up", "up right", "left", "left auto").

Specified by:

setDirection in interface IContextMenu

getDirection

public java.lang.String getDirection()

Return the value of the direction property.

Contents: Forces the direction in which the context menu will be displayed, regardless of the position of the mouse pointer in the viewport. Possible values are combinations of "up" and "down" with "left" and "right", separated by a space, and "auto" can also be used in place of any of those values (e.g. "up", "up right", "left", "left auto"). Default = 'auto'.

Specified by:

getDirection in interface IContextMenu

setEffect

public void setEffect(java.lang.String effect)

Set the value of the effect property.

Contents: Sets the effect for the menu display. Possible values are 'blind', 'clip', 'drop', 'explode, 'fade', 'fold', 'puff', 'slide', 'scale', 'bounce', 'highlight', 'pulsate', and 'shake' (This feature is not supported in IE7 and IE8, see wiki page for more information).

Specified by:

setEffect in interface IContextMenu

getEffect

public java.lang.String getEffect()

Return the value of the effect property.

Contents: Sets the effect for the menu display. Possible values are 'blind', 'clip', 'drop', 'explode, 'fade', 'fold', 'puff', 'slide', 'scale', 'bounce', 'highlight', 'pulsate', and 'shake' (This feature is not supported in IE7 and IE8, see wiki page for more information). Default = 'fade'.

Specified by:

getEffect in interface IContextMenu

setEffectDuration

public void setEffectDuration(int effectDuration)

Set the value of the effectDuration property.

Contents: Sets the effect duration in milliseconds.

Specified by:

setEffectDuration in interface IContextMenu

getEffectDuration

public int getEffectDuration()

Return the value of the effectDuration property.

Contents: Sets the effect duration in milliseconds. Default = '400'.

Specified by:

getEffectDuration in interface IContextMenu

setFetch

public void setFetch(javax.el.ValueExpression fetch)

Set the value of the fetch property.

Specified by:

setFetch in interface IContextMenu

getFetch

public javax.el.ValueExpression getFetch()

Return the value of the fetch property.

Specified by:

getFetch in interface IContextMenu

setFor

public void setFor(java.lang.String forValue)

Set the value of the for property.

Contents: Server side id of the component to attach to.

Specified by:

setFor in interface IContextMenu

getFor

public java.lang.String getFor()

Return the value of the for property.

Contents: Server side id of the component to attach to.

Specified by:

getFor in interface IContextMenu

setForDelegate

public void setForDelegate(java.lang.String forDelegate)

Set the value of the forDelegate property.

Contents: Server side id of the ace:delegate component to attach to.

Specified by:

setForDelegate in interface IContextMenu

getForDelegate

public java.lang.String getForDelegate()

Return the value of the forDelegate property.

Contents: Server side id of the ace:delegate component to attach to.

Specified by:

getForDelegate in interface IContextMenu

setForceMenuUpdate

public void setForceMenuUpdate(java.lang.Boolean forceMenuUpdate)

Set the value of the forceMenuUpdate property.

Contents: Set to true when the entire menu needs to be updated in the client, such as when an individual menu item changes label or styling, and the entire menu needs to be reinitialized in the client in order to get all the styling and behaviour re-applied to the new HTML nodes. The value of this attribute will be automatically set to false by the component after consuming it (if applicable).

Specified by:

setForceMenuUpdate in interface IContextMenu

isForceMenuUpdate

public java.lang.Boolean isForceMenuUpdate()

Return the value of the forceMenuUpdate property.

Contents: Set to true when the entire menu needs to be updated in the client, such as when an individual menu item changes label or styling, and the entire menu needs to be reinitialized in the client in order to get all the styling and behaviour re-applied to the new HTML nodes. The value of this attribute will be automatically set to false by the component after consuming it (if applicable). Default = 'false'.

Specified by:

isForceMenuUpdate in interface IContextMenu

setModel

public void setModel(MenuModel model)

Set the value of the model property.

Contents: MenuModel instance to create menus programmatically. For the menuitem and submenu components, use explicit ids, and avoid long processing in the getter method for this property, as it will be called multiple times, in every lifecycle. If using MyFaces, see wiki page for some known issues.

Specified by:

setModel in interface IContextMenu

getModel

public MenuModel getModel()

Return the value of the model property.

Contents: MenuModel instance to create menus programmatically. For the menuitem and submenu components, use explicit ids, and avoid long processing in the getter method for this property, as it will be called multiple times, in every lifecycle. If using MyFaces, see wiki page for some known issues.

Specified by:

getModel in interface IContextMenu

Specified by:

getModel in class AbstractMenu

setStore

public void setStore(java.lang.Object store)

Set the value of the store property.

Specified by:

setStore in interface IContextMenu

getStore

public java.lang.Object getStore()

Return the value of the store property.

Specified by:

getStore in interface IContextMenu

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

Contents: Style of the main container element.

Specified by:

setStyle in interface IContextMenu

getStyle

public java.lang.String getStyle()

Return the value of the style property.

Contents: Style of the main container element.

Specified by:

getStyle in interface IContextMenu

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

Contents: Style class of the main container element.

Specified by:

setStyleClass in interface IContextMenu

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property.

Contents: Style class of the main container element.

Specified by:

getStyleClass in interface IContextMenu

setZindex

public void setZindex(int zindex)

Set the value of the zindex property.

Contents: zindex property to control overlapping with other elements.

Specified by:

setZindex in interface IContextMenu

getZindex

public int getZindex()

Return the value of the zindex property.

Contents: zindex property to control overlapping with other elements. Default = '1'.

Specified by:

getZindex in interface IContextMenu

setForceUpdateCounter

public void setForceUpdateCounter(java.lang.Integer forceUpdateCounter)

Set the value of the forceUpdateCounter property.

Specified by:

setForceUpdateCounter in interface IContextMenu

getForceUpdateCounter

public java.lang.Integer getForceUpdateCounter()

Return the value of the forceUpdateCounter property.

Specified by:

getForceUpdateCounter in interface IContextMenu

setSubmenuLabels

public void setSubmenuLabels(java.lang.String submenuLabels)

Set the value of the submenuLabels property.

Specified by:

setSubmenuLabels in interface IContextMenu

getSubmenuLabels

public java.lang.String getSubmenuLabels()

Return the value of the submenuLabels property.

Specified by:

getSubmenuLabels in interface IContextMenu

isPropertySet

protected boolean isPropertySet(java.lang.String finder)

setValueExpression

public void setValueExpression(java.lang.String name,
                      javax.el.ValueExpression binding)

Overrides:

setValueExpression in class javax.faces.component.UIComponent