@Generated(value={"RichFaces CDK","4.3.1.Final"}) public class UIContextMenu extends AbstractContextMenu implements javax.faces.component.behavior.ClientBehaviorHolder
The <rich:contextMenu> component is used for creating a hierarchical context menu that are activated on events like onmouseover, onclick etc. The component can be applied to any element on the page.
Modifier and Type | Class and Description |
---|---|
protected static class |
UIContextMenu.Properties |
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
Constructor and Description |
---|
UIContextMenu() |
Modifier and Type | Method and Description |
---|---|
String |
getDefaultEventName() |
String |
getDir() |
org.richfaces.component.Positioning |
getDirection() |
Collection<String> |
getEventNames() |
String |
getFamily() |
int |
getHideDelay()
Delay (in ms) between losing focus and menu closing
|
int |
getHorizontalOffset() |
org.richfaces.component.Positioning |
getJointPoint() |
String |
getLang() |
org.richfaces.component.Mode |
getMode()
Sets the submission mode for all menu items of the menu except those where this attribute redefined.
|
String |
getOnclick() |
String |
getOndblclick() |
String |
getOngrouphide()
The client-side script method to be called when a child menuGroup is hidden
|
String |
getOngroupshow()
The client-side script method to be called when a child menuGroup is expanded
|
String |
getOnhide()
The client-side script method to be called when this menu component is hidden
|
String |
getOnitemclick()
The client-side script method to be called when a menu item is clicked
|
String |
getOnkeydown() |
String |
getOnkeypress() |
String |
getOnkeyup() |
String |
getOnmousedown() |
String |
getOnmousemove() |
String |
getOnmouseout() |
String |
getOnmouseover() |
String |
getOnmouseup() |
String |
getOnshow()
The client-side script method to be called when this menu component is shown
|
int |
getPopupWidth()
Sets minimum width for all lists that will appear.
|
int |
getShowDelay()
Delay (in ms) between observing the showEvent and menu opening
|
String |
getShowEvent()
Defines an event on the parent element to display the menu
|
String |
getStyle() |
String |
getStyleClass() |
String |
getTarget()
Client identifier of the component or id of the existing DOM element that is a source for a given event.
|
String |
getTargetSelector()
The jQuery selector used to filter which child DOM elements of the target/parent to which the contextMenu will
be attached.
|
String |
getTitle() |
int |
getVerticalOffset() |
boolean |
isAttached()
If the value of the 'attached' attribute is true, the component is attached to the component, specified in the
'target' attribute or to the parent component, if 'target' is not defined.
|
boolean |
isDisabled()
Disables the menu component, so it will not activate/expand
|
void |
setAttached(boolean attached) |
void |
setDir(String dir) |
void |
setDirection(org.richfaces.component.Positioning direction) |
void |
setDisabled(boolean disabled) |
void |
setHideDelay(int hideDelay) |
void |
setHorizontalOffset(int horizontalOffset) |
void |
setJointPoint(org.richfaces.component.Positioning jointPoint) |
void |
setLang(String lang) |
void |
setMode(org.richfaces.component.Mode mode) |
void |
setOnclick(String onclick) |
void |
setOndblclick(String ondblclick) |
void |
setOngrouphide(String ongrouphide) |
void |
setOngroupshow(String ongroupshow) |
void |
setOnhide(String onhide) |
void |
setOnitemclick(String onitemclick) |
void |
setOnkeydown(String onkeydown) |
void |
setOnkeypress(String onkeypress) |
void |
setOnkeyup(String onkeyup) |
void |
setOnmousedown(String onmousedown) |
void |
setOnmousemove(String onmousemove) |
void |
setOnmouseout(String onmouseout) |
void |
setOnmouseover(String onmouseover) |
void |
setOnmouseup(String onmouseup) |
void |
setOnshow(String onshow) |
void |
setPopupWidth(int popupWidth) |
void |
setShowDelay(int showDelay) |
void |
setShowEvent(String showEvent) |
void |
setStyle(String style) |
void |
setStyleClass(String styleClass) |
void |
setTarget(String target) |
void |
setTargetSelector(String targetSelector) |
void |
setTitle(String title) |
void |
setVerticalOffset(int verticalOffset) |
getCssRoot
addClientBehavior, addFacesListener, broadcast, clearInitialState, 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, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent
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
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public String getFamily()
getFamily
in class javax.faces.component.UIComponent
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
getEventNames
in class javax.faces.component.UIComponentBase
public String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class javax.faces.component.UIComponentBase
public boolean isAttached()
AbstractContextMenu
isAttached
in class AbstractContextMenu
public void setAttached(boolean attached)
public String getDir()
public void setDir(String dir)
public org.richfaces.component.Positioning getDirection()
getDirection
in class AbstractMenuContainer
public void setDirection(org.richfaces.component.Positioning direction)
public boolean isDisabled()
AbstractMenuContainer
isDisabled
in class AbstractMenuContainer
public void setDisabled(boolean disabled)
public int getHideDelay()
AbstractMenuContainer
Delay (in ms) between losing focus and menu closing
Default value is "300"
getHideDelay
in class AbstractMenuContainer
public void setHideDelay(int hideDelay)
public int getHorizontalOffset()
getHorizontalOffset
in class AbstractMenuContainer
public void setHorizontalOffset(int horizontalOffset)
public org.richfaces.component.Positioning getJointPoint()
getJointPoint
in class AbstractContextMenu
public void setJointPoint(org.richfaces.component.Positioning jointPoint)
public String getLang()
public void setLang(String lang)
public org.richfaces.component.Mode getMode()
AbstractMenuContainer
Sets the submission mode for all menu items of the menu except those where this attribute redefined. Possible value are 'ajax','client' and 'server'
Default value is 'server'
getMode
in class AbstractMenuContainer
public void setMode(org.richfaces.component.Mode mode)
public String getOnclick()
public void setOnclick(String onclick)
public String getOndblclick()
public void setOndblclick(String ondblclick)
public String getOngrouphide()
AbstractMenuContainer
getOngrouphide
in class AbstractMenuContainer
public void setOngrouphide(String ongrouphide)
public String getOngroupshow()
AbstractMenuContainer
getOngroupshow
in class AbstractMenuContainer
public void setOngroupshow(String ongroupshow)
public String getOnhide()
AbstractMenuContainer
getOnhide
in class AbstractMenuContainer
public void setOnhide(String onhide)
public String getOnitemclick()
AbstractMenuContainer
getOnitemclick
in class AbstractMenuContainer
public void setOnitemclick(String onitemclick)
public String getOnkeydown()
public void setOnkeydown(String onkeydown)
public String getOnkeypress()
public void setOnkeypress(String onkeypress)
public String getOnkeyup()
public void setOnkeyup(String onkeyup)
public String getOnmousedown()
public void setOnmousedown(String onmousedown)
public String getOnmousemove()
public void setOnmousemove(String onmousemove)
public String getOnmouseout()
public void setOnmouseout(String onmouseout)
public String getOnmouseover()
public void setOnmouseover(String onmouseover)
public String getOnmouseup()
public void setOnmouseup(String onmouseup)
public String getOnshow()
AbstractMenuContainer
getOnshow
in class AbstractMenuContainer
public void setOnshow(String onshow)
public int getPopupWidth()
AbstractMenuContainer
getPopupWidth
in class AbstractMenuContainer
public void setPopupWidth(int popupWidth)
public int getShowDelay()
AbstractMenuContainer
Delay (in ms) between observing the showEvent and menu opening
Default value is "50"
getShowDelay
in class AbstractMenuContainer
public void setShowDelay(int showDelay)
public String getShowEvent()
AbstractMenuContainer
Defines an event on the parent element to display the menu
Default value is 'contextmenu'
getShowEvent
in class AbstractMenuContainer
public void setShowEvent(String showEvent)
public String getStyle()
public void setStyle(String style)
public String getStyleClass()
public void setStyleClass(String styleClass)
public String getTarget()
AbstractContextMenu
getTarget
in class AbstractContextMenu
public void setTarget(String target)
public String getTargetSelector()
AbstractContextMenu
getTargetSelector
in class AbstractContextMenu
public void setTargetSelector(String targetSelector)
public String getTitle()
public void setTitle(String title)
public int getVerticalOffset()
getVerticalOffset
in class AbstractMenuContainer
public void setVerticalOffset(int verticalOffset)
Copyright © 2014 JBoss by Red Hat. All Rights Reserved.