Class UIMenuItem
- java.lang.Object
-
- javax.faces.component.UIComponent
-
- javax.faces.component.UIComponentBase
-
- javax.faces.component.UICommand
-
- org.primefaces.component.menuitem.UIMenuItemBase
-
- org.primefaces.component.menuitem.UIMenuItem
-
- All Implemented Interfaces:
EventListener
,javax.faces.component.ActionSource
,javax.faces.component.ActionSource2
,javax.faces.component.behavior.ClientBehaviorHolder
,javax.faces.component.PartialStateHolder
,javax.faces.component.StateHolder
,javax.faces.component.TransientStateHolder
,javax.faces.event.ComponentSystemEventListener
,javax.faces.event.FacesListener
,javax.faces.event.SystemEventListenerHolder
,AjaxSource
,Confirmable
,DialogReturnAware
,PrimeClientBehaviorHolder
,UIOutcomeTarget
,MenuElement
,MenuItem
public class UIMenuItem extends UIMenuItemBase implements DialogReturnAware
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.primefaces.component.menuitem.UIMenuItemBase
UIMenuItemBase.PropertyKeys
-
-
Field Summary
Fields Modifier and Type Field Description static String
COMPONENT_TYPE
-
Fields inherited from class org.primefaces.component.menuitem.UIMenuItemBase
COMPONENT_FAMILY
-
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.DialogReturnAware
ATTRIBUTE_DIALOG_RETURN_SCRIPT, EVENT_DIALOG_RETURN
-
-
Constructor Summary
Constructors Constructor Description UIMenuItem()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
decode(javax.faces.context.FacesContext facesContext)
Map<String,Class<? extends javax.faces.event.BehaviorEvent>>
getBehaviorEventMapping()
String
getCommand()
AMethodExpression
in the form of a string which is called after the menu item has been clicked.String
getConfirmationScript()
String
getDefaultEventName()
Collection<String>
getEventNames()
String
getHref()
Map<String,List<String>>
getParams()
boolean
isAjaxified()
boolean
isDynamic()
boolean
isPartialSubmitSet()
boolean
isResetValuesSet()
void
queueEvent(javax.faces.event.FacesEvent e)
boolean
requiresConfirmation()
void
setConfirmationScript(String confirmationScript)
void
setParam(String key, Object value)
boolean
shouldRenderChildren()
-
Methods inherited from class org.primefaces.component.menuitem.UIMenuItemBase
getContainerStyle, getContainerStyleClass, getDelay, getFamily, getForm, getFragment, getFunction, getIcon, getIconPos, getOnclick, getOncomplete, getOnerror, getOnstart, getOnsuccess, getOutcome, getPartialSubmitFilter, getProcess, getRel, getStyle, getStyleClass, getTarget, getTimeout, getTitle, getUpdate, getUrl, isAjax, isAsync, isDisableClientWindow, isDisabled, isEscape, isGlobal, isIgnoreAutoUpdate, isIgnoreComponentNotFound, isIncludeViewParams, isPartialSubmit, isResetValues, setAjax, setAsync, setContainerStyle, setContainerStyleClass, setDelay, setDisableClientWindow, setDisabled, setEscape, setForm, setFragment, setGlobal, setIcon, setIconPos, setIgnoreAutoUpdate, setIgnoreComponentNotFound, setIncludeViewParams, setOnclick, setOncomplete, setOnerror, setOnstart, setOnsuccess, setOutcome, setPartialSubmit, setPartialSubmitFilter, setProcess, setRel, setResetValues, setStyle, setStyleClass, setTarget, setTimeout, setTitle, setUpdate, setUrl
-
Methods inherited from class javax.faces.component.UICommand
addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getValue, isImmediate, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValue
-
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, clearInitialState, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, 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 javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors
-
Methods inherited from interface org.primefaces.component.api.DialogReturnAware
isDialogReturnEvent, queueDialogReturnEvent
-
Methods inherited from interface org.primefaces.model.menu.MenuElement
getId, isRendered, setId
-
Methods inherited from interface org.primefaces.model.menu.MenuItem
getClientId, getValue, isImmediate
-
Methods inherited from interface org.primefaces.component.api.UIOutcomeTarget
getChildren
-
-
-
-
Field Detail
-
COMPONENT_TYPE
public static final String COMPONENT_TYPE
- See Also:
- Constant Field Values
-
-
Method Detail
-
getBehaviorEventMapping
public Map<String,Class<? extends javax.faces.event.BehaviorEvent>> getBehaviorEventMapping()
- Specified by:
getBehaviorEventMapping
in interfacePrimeClientBehaviorHolder
-
getEventNames
public Collection<String> getEventNames()
- Specified by:
getEventNames
in interfacejavax.faces.component.behavior.ClientBehaviorHolder
- Overrides:
getEventNames
in classjavax.faces.component.UIComponentBase
-
getDefaultEventName
public String getDefaultEventName()
- Specified by:
getDefaultEventName
in interfacejavax.faces.component.behavior.ClientBehaviorHolder
- Overrides:
getDefaultEventName
in classjavax.faces.component.UIComponentBase
-
decode
public void decode(javax.faces.context.FacesContext facesContext)
- Overrides:
decode
in classjavax.faces.component.UIComponentBase
-
queueEvent
public void queueEvent(javax.faces.event.FacesEvent e)
- Overrides:
queueEvent
in classjavax.faces.component.UICommand
-
shouldRenderChildren
public boolean shouldRenderChildren()
- Specified by:
shouldRenderChildren
in interfaceMenuItem
-
isPartialSubmitSet
public boolean isPartialSubmitSet()
- Specified by:
isPartialSubmitSet
in interfaceAjaxSource
-
isResetValuesSet
public boolean isResetValuesSet()
- Specified by:
isResetValuesSet
in interfaceAjaxSource
-
getHref
public String getHref()
- Specified by:
getHref
in interfaceUIOutcomeTarget
-
getParams
public Map<String,List<String>> getParams()
- Specified by:
getParams
in interfaceMenuItem
- Specified by:
getParams
in interfaceUIOutcomeTarget
-
getCommand
public String getCommand()
Description copied from interface:MenuItem
AMethodExpression
in the form of a string which is called after the menu item has been clicked. It is ignored whenurl
is notnull
.- Specified by:
getCommand
in interfaceMenuItem
- Returns:
- The outcome, which will be used for navigation.
-
isAjaxified
public boolean isAjaxified()
- Specified by:
isAjaxified
in interfaceAjaxSource
-
getConfirmationScript
public String getConfirmationScript()
- Specified by:
getConfirmationScript
in interfaceConfirmable
-
setConfirmationScript
public void setConfirmationScript(String confirmationScript)
- Specified by:
setConfirmationScript
in interfaceConfirmable
-
requiresConfirmation
public boolean requiresConfirmation()
- Specified by:
requiresConfirmation
in interfaceConfirmable
-
-