|
ICEfaces ACE Components 3.3.0 Java API Documentation |
||||||||
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
org.icefaces.ace.component.menu.AbstractMenu
org.icefaces.ace.component.contextmenu.ContextMenuBase
public class ContextMenuBase
ContextMenu provides a popup menu that is displayed on mouse right-click event.
For more information, see the ContextMenu Wiki Documentation.
Nested Class Summary | |
---|---|
protected static class |
ContextMenuBase.PropertyKeys
|
Field Summary | |
---|---|
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 | |
---|---|
ContextMenuBase()
|
Method Summary | |
---|---|
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()
|
java.lang.String |
getFor()
Return the value of the for property. |
MenuModel |
getModel()
Return the value of the model 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 |
getWidgetVar()
Return the value of the widgetVar property. |
int |
getZindex()
Return the value of the zindex property. |
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 |
setFor(java.lang.String forValue)
Set the value of the for property. |
void |
setModel(MenuModel model)
Set the value of the model 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 |
setWidgetVar(java.lang.String widgetVar)
Set the value of the widgetVar property. |
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, 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, 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 |
Field Detail |
---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String RENDERER_TYPE
Constructor Detail |
---|
public ContextMenuBase()
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIComponent
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").
setDirection
in interface IContextMenu
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'.
getDirection
in interface IContextMenu
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).
setEffect
in interface IContextMenu
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'.
getEffect
in interface IContextMenu
public void setEffectDuration(int effectDuration)
Set the value of the effectDuration
property.
Contents: Sets the effect duration in milliseconds.
setEffectDuration
in interface IContextMenu
public int getEffectDuration()
Return the value of the effectDuration
property.
Contents: Sets the effect duration in milliseconds. Default = '400'.
getEffectDuration
in interface IContextMenu
public void setFor(java.lang.String forValue)
Set the value of the for
property.
Contents: Server side id of the component to attach to.
setFor
in interface IContextMenu
public java.lang.String getFor()
Return the value of the for
property.
Contents: Server side id of the component to attach to.
getFor
in interface IContextMenu
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.
setModel
in interface IContextMenu
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.
getModel
in interface IContextMenu
getModel
in class AbstractMenu
public void setStyle(java.lang.String style)
Set the value of the style
property.
Contents: Style of the main container element.
setStyle
in interface IContextMenu
public java.lang.String getStyle()
Return the value of the style
property.
Contents: Style of the main container element.
getStyle
in interface IContextMenu
public void setStyleClass(java.lang.String styleClass)
Set the value of the styleClass
property.
Contents: Style class of the main container element.
setStyleClass
in interface IContextMenu
public java.lang.String getStyleClass()
Return the value of the styleClass
property.
Contents: Style class of the main container element.
getStyleClass
in interface IContextMenu
public void setWidgetVar(java.lang.String widgetVar)
Set the value of the widgetVar
property.
Contents: Javascript variable name of the wrapped widget.
setWidgetVar
in interface IContextMenu
public java.lang.String getWidgetVar()
Return the value of the widgetVar
property.
Contents: Javascript variable name of the wrapped widget.
getWidgetVar
in interface IContextMenu
public void setZindex(int zindex)
Set the value of the zindex
property.
Contents: zindex property to control overlapping with other elements.
setZindex
in interface IContextMenu
public int getZindex()
Return the value of the zindex
property.
Contents: zindex property to control overlapping with other elements. Default = '1'.
getZindex
in interface IContextMenu
|
ICEfaces ACE Components 3.3.0 Java API Documentation |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |