UIMenuItem (primefaces-6.2.9 6.2.9 API)

java.lang.Object
- javax.faces.component.UIComponent
- - javax.faces.component.UIComponentBase
  - - javax.faces.component.UICommand
    - - 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.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, AjaxSource, Confirmable, PrimeClientBehaviorHolder, UIOutcomeTarget, MenuElement, MenuItem
```
public class UIMenuItem
extends javax.faces.component.UICommand
implements AjaxSource, UIOutcomeTarget, MenuItem, Confirmable, javax.faces.component.behavior.ClientBehaviorHolder, PrimeClientBehaviorHolder
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UIMenuItem.PropertyKeys

Nested Classes
Modifier and Type	Class and Description
`static class`	`UIMenuItem.PropertyKeys`

Field Summary

Fields
Modifier and Type Field and Description

static String COMPONENT_FAMILY

static String COMPONENT_TYPE
- Fields inherited from class javax.faces.component.UIComponent
  BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

Fields
Modifier and Type	Field and Description
`static String`	`COMPONENT_FAMILY`
`static String`	`COMPONENT_TYPE`

Constructor Summary

Constructors
Constructor and Description

UIMenuItem()

Constructors
Constructor and Description
`UIMenuItem()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`decode(javax.faces.context.FacesContext facesContext)`
`Map<String,Class<? extends javax.faces.event.BehaviorEvent>>`	`getBehaviorEventMapping()`
`String`	`getCommand()`
`String`	`getConfirmationScript()`
`String`	`getContainerStyle()`
`String`	`getContainerStyleClass()`
`String`	`getDefaultEventName()`
`String`	`getDelay()`
`Collection<String>`	`getEventNames()`
`String`	`getFamily()`
`String`	`getForm()`
`String`	`getFragment()`
`String`	`getHref()`
`String`	`getIcon()`
`String`	`getIconPos()`
`String`	`getOnclick()`
`String`	`getOncomplete()`
`String`	`getOnerror()`
`String`	`getOnstart()`
`String`	`getOnsuccess()`
`String`	`getOutcome()`
`Map<String,List<String>>`	`getParams()`
`String`	`getPartialSubmitFilter()`
`String`	`getProcess()`
`String`	`getRel()`
`String`	`getStyle()`
`String`	`getStyleClass()`
`String`	`getTarget()`
`int`	`getTimeout()`
`String`	`getTitle()`
`String`	`getUpdate()`
`String`	`getUrl()`
`boolean`	`isAjax()`
`boolean`	`isAjaxified()`
`boolean`	`isAsync()`
`boolean`	`isDisableClientWindow()`
`boolean`	`isDisabled()`
`boolean`	`isDynamic()`
`boolean`	`isEscape()`
`boolean`	`isGlobal()`
`boolean`	`isIgnoreAutoUpdate()`
`boolean`	`isIncludeViewParams()`
`boolean`	`isPartialSubmit()`
`boolean`	`isPartialSubmitSet()`
`boolean`	`isResetValues()`
`boolean`	`isResetValuesSet()`
`boolean`	`requiresConfirmation()`
`void`	`setAjax(boolean _ajax)`
`void`	`setAsync(boolean _async)`
`void`	`setConfirmationScript(String confirmationScript)`
`void`	`setContainerStyle(String _containerStyle)`
`void`	`setContainerStyleClass(String _containerStyleClass)`
`void`	`setDelay(String _delay)`
`void`	`setDisableClientWindow(boolean _disableClientWindow)`
`void`	`setDisabled(boolean _disabled)`
`void`	`setEscape(boolean _escape)`
`void`	`setForm(String _form)`
`void`	`setFragment(String _fragment)`
`void`	`setGlobal(boolean _global)`
`void`	`setIcon(String _icon)`
`void`	`setIconPos(String _iconPos)`
`void`	`setIgnoreAutoUpdate(boolean _ignoreAutoUpdate)`
`void`	`setIncludeViewParams(boolean _includeViewParams)`
`void`	`setOnclick(String _onclick)`
`void`	`setOncomplete(String _oncomplete)`
`void`	`setOnerror(String _onerror)`
`void`	`setOnstart(String _onstart)`
`void`	`setOnsuccess(String _onsuccess)`
`void`	`setOutcome(String _outcome)`
`void`	`setParam(String key, Object value)`
`void`	`setPartialSubmit(boolean _partialSubmit)`
`void`	`setPartialSubmitFilter(String _partialSubmitFilter)`
`void`	`setProcess(String _process)`
`void`	`setRel(String _rel)`
`void`	`setResetValues(boolean _resetValues)`
`void`	`setStyle(String _style)`
`void`	`setStyleClass(String _styleClass)`
`void`	`setTarget(String _target)`
`void`	`setTimeout(int _timeout)`
`void`	`setTitle(String _title)`
`void`	`setUpdate(String _update)`
`void`	`setUrl(String _url)`
`boolean`	`shouldRenderChildren()`

Methods inherited from class javax.faces.component.UICommand
addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getValue, isImmediate, queueEvent, 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, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent, visitTree

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.primefaces.component.api.UIOutcomeTarget
getChildren

Methods inherited from interface org.primefaces.model.menu.MenuItem
getClientId, getValue, isImmediate

Methods inherited from interface org.primefaces.model.menu.MenuElement
getId, isRendered, setId

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors

- 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
  - UIMenuItem
```
public UIMenuItem()
```
- Method Detail
  - getFamily
```
public String getFamily()
```
    Overrides:
    
    getFamily in class javax.faces.component.UICommand
  - getUrl
```
public String getUrl()
```
    Specified by:
    
    getUrl in interface MenuItem
  - setUrl
```
public void setUrl(String _url)
```
  - getTarget
```
public String getTarget()
```
    Specified by:
    
    getTarget in interface MenuItem
  - setTarget
```
public void setTarget(String _target)
```
  - getStyle
```
public String getStyle()
```
    Specified by:
    
    getStyle in interface MenuItem
  - setStyle
```
public void setStyle(String _style)
```
  - getStyleClass
```
public String getStyleClass()
```
    Specified by:
    
    getStyleClass in interface MenuItem
  - setStyleClass
```
public void setStyleClass(String _styleClass)
```
    Specified by:
    
    setStyleClass in interface MenuItem
  - getOnclick
```
public String getOnclick()
```
    Specified by:
    
    getOnclick in interface MenuItem
  - setOnclick
```
public void setOnclick(String _onclick)
```
  - getUpdate
```
public String getUpdate()
```
    Specified by:
    
    getUpdate in interface AjaxSource
  - setUpdate
```
public void setUpdate(String _update)
```
  - getProcess
```
public String getProcess()
```
    Specified by:
    
    getProcess in interface AjaxSource
  - setProcess
```
public void setProcess(String _process)
```
  - getOnstart
```
public String getOnstart()
```
    Specified by:
    
    getOnstart in interface AjaxSource
  - setOnstart
```
public void setOnstart(String _onstart)
```
  - isDisabled
```
public boolean isDisabled()
```
    Specified by:
    
    isDisabled in interface MenuItem
  - setDisabled
```
public void setDisabled(boolean _disabled)
```
  - getOncomplete
```
public String getOncomplete()
```
    Specified by:
    
    getOncomplete in interface AjaxSource
  - setOncomplete
```
public void setOncomplete(String _oncomplete)
```
  - getOnerror
```
public String getOnerror()
```
    Specified by:
    
    getOnerror in interface AjaxSource
  - setOnerror
```
public void setOnerror(String _onerror)
```
  - getOnsuccess
```
public String getOnsuccess()
```
    Specified by:
    
    getOnsuccess in interface AjaxSource
  - setOnsuccess
```
public void setOnsuccess(String _onsuccess)
```
  - isGlobal
```
public boolean isGlobal()
```
    Specified by:
    
    isGlobal in interface AjaxSource
  - setGlobal
```
public void setGlobal(boolean _global)
```
  - getDelay
```
public String getDelay()
```
    Specified by:
    
    getDelay in interface AjaxSource
  - setDelay
```
public void setDelay(String _delay)
```
  - getTimeout
```
public int getTimeout()
```
    Specified by:
    
    getTimeout in interface AjaxSource
  - setTimeout
```
public void setTimeout(int _timeout)
```
  - isAsync
```
public boolean isAsync()
```
    Specified by:
    
    isAsync in interface AjaxSource
  - setAsync
```
public void setAsync(boolean _async)
```
  - isAjax
```
public boolean isAjax()
```
    Specified by:
    
    isAjax in interface MenuItem
  - setAjax
```
public void setAjax(boolean _ajax)
```
  - getIcon
```
public String getIcon()
```
    Specified by:
    
    getIcon in interface MenuItem
  - setIcon
```
public void setIcon(String _icon)
```
  - getIconPos
```
public String getIconPos()
```
    Specified by:
    
    getIconPos in interface MenuItem
  - setIconPos
```
public void setIconPos(String _iconPos)
```
  - isPartialSubmit
```
public boolean isPartialSubmit()
```
    Specified by:
    
    isPartialSubmit in interface AjaxSource
  - setPartialSubmit
```
public void setPartialSubmit(boolean _partialSubmit)
```
  - isResetValues
```
public boolean isResetValues()
```
    Specified by:
    
    isResetValues in interface AjaxSource
  - setResetValues
```
public void setResetValues(boolean _resetValues)
```
  - isIgnoreAutoUpdate
```
public boolean isIgnoreAutoUpdate()
```
    Specified by:
    
    isIgnoreAutoUpdate in interface AjaxSource
  - setIgnoreAutoUpdate
```
public void setIgnoreAutoUpdate(boolean _ignoreAutoUpdate)
```
  - getTitle
```
public String getTitle()
```
    Specified by:
    
    getTitle in interface MenuItem
  - setTitle
```
public void setTitle(String _title)
```
  - getOutcome
```
public String getOutcome()
```
    Specified by:
    
    getOutcome in interface UIOutcomeTarget
    
    Specified by:
    
    getOutcome in interface MenuItem
  - setOutcome
```
public void setOutcome(String _outcome)
```
  - isIncludeViewParams
```
public boolean isIncludeViewParams()
```
    Specified by:
    
    isIncludeViewParams in interface UIOutcomeTarget
    
    Specified by:
    
    isIncludeViewParams in interface MenuItem
  - setIncludeViewParams
```
public void setIncludeViewParams(boolean _includeViewParams)
```
  - getFragment
```
public String getFragment()
```
    Specified by:
    
    getFragment in interface UIOutcomeTarget
    
    Specified by:
    
    getFragment in interface MenuItem
  - setFragment
```
public void setFragment(String _fragment)
```
  - isDisableClientWindow
```
public boolean isDisableClientWindow()
```
    Specified by:
    
    isDisableClientWindow in interface UIOutcomeTarget
  - setDisableClientWindow
```
public void setDisableClientWindow(boolean _disableClientWindow)
```
  - getContainerStyle
```
public String getContainerStyle()
```
    Specified by:
    
    getContainerStyle in interface MenuItem
  - setContainerStyle
```
public void setContainerStyle(String _containerStyle)
```
  - getContainerStyleClass
```
public String getContainerStyleClass()
```
    Specified by:
    
    getContainerStyleClass in interface MenuItem
  - setContainerStyleClass
```
public void setContainerStyleClass(String _containerStyleClass)
```
  - getPartialSubmitFilter
```
public String getPartialSubmitFilter()
```
    Specified by:
    
    getPartialSubmitFilter in interface AjaxSource
  - setPartialSubmitFilter
```
public void setPartialSubmitFilter(String _partialSubmitFilter)
```
  - getForm
```
public String getForm()
```
    Specified by:
    
    getForm in interface AjaxSource
  - setForm
```
public void setForm(String _form)
```
  - isEscape
```
public boolean isEscape()
```
    Specified by:
    
    isEscape in interface MenuItem
  - setEscape
```
public void setEscape(boolean _escape)
```
  - getRel
```
public String getRel()
```
    Specified by:
    
    getRel in interface MenuItem
  - setRel
```
public void setRel(String _rel)
```
  - getBehaviorEventMapping
```
public Map<String,Class<? extends javax.faces.event.BehaviorEvent>> getBehaviorEventMapping()
```
    Specified by:
    
    getBehaviorEventMapping in interface PrimeClientBehaviorHolder
  - getEventNames
```
public Collection<String> getEventNames()
```
    Specified by:
    
    getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder
    
    Overrides:
    
    getEventNames in class javax.faces.component.UIComponentBase
  - getDefaultEventName
```
public String getDefaultEventName()
```
    Specified by:
    
    getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder
    
    Overrides:
    
    getDefaultEventName in class javax.faces.component.UIComponentBase
  - decode
```
public void decode(javax.faces.context.FacesContext facesContext)
```
    Overrides:
    
    decode in class javax.faces.component.UIComponentBase
  - shouldRenderChildren
```
public boolean shouldRenderChildren()
```
    Specified by:
    
    shouldRenderChildren in interface MenuItem
  - isPartialSubmitSet
```
public boolean isPartialSubmitSet()
```
    Specified by:
    
    isPartialSubmitSet in interface AjaxSource
  - isResetValuesSet
```
public boolean isResetValuesSet()
```
    Specified by:
    
    isResetValuesSet in interface AjaxSource
  - getHref
```
public String getHref()
```
    Specified by:
    
    getHref in interface UIOutcomeTarget
  - isDynamic
```
public boolean isDynamic()
```
    Specified by:
    
    isDynamic in interface MenuItem
  - getParams
```
public Map<String,List<String>> getParams()
```
    Specified by:
    
    getParams in interface UIOutcomeTarget
    
    Specified by:
    
    getParams in interface MenuItem
  - getCommand
```
public String getCommand()
```
    Specified by:
    
    getCommand in interface MenuItem
  - isAjaxified
```
public boolean isAjaxified()
```
    Specified by:
    
    isAjaxified in interface AjaxSource
  - setParam
```
public void setParam(String key,
                     Object value)
```
    Specified by:
    
    setParam in interface MenuItem
  - getConfirmationScript
```
public String getConfirmationScript()
```
    Specified by:
    
    getConfirmationScript in interface Confirmable
  - setConfirmationScript
```
public void setConfirmationScript(String confirmationScript)
```
    Specified by:
    
    setConfirmationScript in interface Confirmable
  - requiresConfirmation
```
public boolean requiresConfirmation()
```
    Specified by:
    
    requiresConfirmation in interface Confirmable

Class UIMenuItem

Nested Class Summary

Field Summary

Fields inherited from class javax.faces.component.UIComponent

Constructor Summary

Method Summary

Methods inherited from class javax.faces.component.UICommand

Methods inherited from class javax.faces.component.UIComponentBase

Methods inherited from class javax.faces.component.UIComponent

Methods inherited from class java.lang.Object

Methods inherited from interface org.primefaces.component.api.UIOutcomeTarget

Methods inherited from interface org.primefaces.model.menu.MenuItem

Methods inherited from interface org.primefaces.model.menu.MenuElement

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

Field Detail

COMPONENT_TYPE

COMPONENT_FAMILY

Constructor Detail

UIMenuItem

Method Detail

getFamily

getUrl

setUrl

getTarget

setTarget

getStyle

setStyle

getStyleClass

setStyleClass

getOnclick

setOnclick

getUpdate

setUpdate

getProcess

setProcess

getOnstart

setOnstart

isDisabled

setDisabled

getOncomplete

setOncomplete

getOnerror

setOnerror

getOnsuccess

setOnsuccess

isGlobal

setGlobal

getDelay

setDelay

getTimeout

setTimeout

isAsync

setAsync

isAjax

setAjax

getIcon

setIcon

getIconPos

setIconPos

isPartialSubmit

setPartialSubmit

isResetValues

setResetValues

isIgnoreAutoUpdate

setIgnoreAutoUpdate

getTitle

setTitle

getOutcome

setOutcome

isIncludeViewParams

setIncludeViewParams

getFragment

setFragment

isDisableClientWindow

setDisableClientWindow

getContainerStyle

setContainerStyle

getContainerStyleClass

setContainerStyleClass

getPartialSubmitFilter