RichFaces UI Components UI 4.3.0.CR2

org.richfaces.component
Class AbstractContextMenu

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by org.richfaces.component.AbstractMenuContainer
              extended by org.richfaces.component.AbstractContextMenu
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
Direct Known Subclasses:
UIContextMenu

public abstract class AbstractContextMenu
extends AbstractMenuContainer

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.

Author:
Brian Leathem

Field Summary
static String COMPONENT_FAMILY
           
static String 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
 
Constructor Summary
AbstractContextMenu()
           
 
Method Summary
 Object getCssRoot()
           
abstract  org.richfaces.component.Positioning getJointPoint()
           
abstract  String getTarget()
          Client identifier of the component or id of the existing DOM element that is a source for a given event.
abstract  String getTargetSelector()
          The jQuery selector used to filter which child DOM elements of the target/parent to which the contextMenu will be attached.
abstract  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.
 
Methods inherited from class org.richfaces.component.AbstractMenuContainer
getDirection, getHideDelay, getHorizontalOffset, getMode, getOngrouphide, getOngroupshow, getOnhide, getOnitemclick, getOnshow, getPopupWidth, getShowDelay, getShowEvent, getVerticalOffset, isDisabled
 
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, 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, getFamily, 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

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY
See Also:
Constant Field Values
Constructor Detail

AbstractContextMenu

public AbstractContextMenu()
Method Detail

isAttached

public abstract 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. Default value is 'true'.


getTarget

public abstract String getTarget()
Client identifier of the component or id of the existing DOM element that is a source for a given event. If target is defined, the event is attached on the client. If both attached and target attributes are defined, and attribute attached has value 'false', it is considered to have higher priority.


getTargetSelector

public abstract String getTargetSelector()
The jQuery selector used to filter which child DOM elements of the target/parent to which the contextMenu will be attached.


getCssRoot

public Object getCssRoot()
Specified by:
getCssRoot in class AbstractMenuContainer

getJointPoint

public abstract org.richfaces.component.Positioning getJointPoint()
Specified by:
getJointPoint in class AbstractMenuContainer

RichFaces UI Components UI 4.3.0.CR2

Copyright © 2013 JBoss by Red Hat. All Rights Reserved.