UIMenuItem (RichFaces Distribution Assembler 4.5.5.Final API)

java.lang.Object
- javax.faces.component.UIComponent
- - javax.faces.component.UIComponentBase
  - - javax.faces.component.UICommand
    - - org.richfaces.component.AbstractActionComponent
      - org.richfaces.component.AbstractMenuItem
        
        org.richfaces.component.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, AjaxActivatorProps, AjaxProps, BypassProps, CoreProps, DisabledProps, EventsKeyProps, EventsMouseProps, I18nProps
```
@Generated(value={"RichFaces CDK","4.5.0-SNAPSHOT"})
public class UIMenuItem
extends AbstractMenuItem
implements javax.faces.component.behavior.ClientBehaviorHolder, AjaxProps, BypassProps, CoreProps, DisabledProps, EventsKeyProps, EventsMouseProps, I18nProps
```
The <rich:menuItem> component represents a single item in a menu control. The <rich:menuItem> component can be also be used as a seperate component without a parent menu component, such as on a toolbar.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class UIMenuItem.Properties
- Nested classes/interfaces inherited from class org.richfaces.component.AbstractMenuItem
  AbstractMenuItem.Facets

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

Field Summary

Fields
Modifier and Type Field and Description

static String COMPONENT_FAMILY

static String COMPONENT_TYPE
- Fields inherited from class org.richfaces.component.AbstractMenuItem
  CSS_ROOT_DEFAULT
- 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
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

Methods
Modifier and Type	Method and Description
`Object`	`getData()` Serialized (on default with JSON) data passed to the client by a developer on an AJAX request.
`String`	`getDefaultEventName()`
`String`	`getDir()` Direction indication for text that does not inherit directionality.
`Collection<String>`	`getEventNames()`
`Object`	`getExecute()` IDs of components that will participate in the "execute" portion of the Request Processing Lifecycle.
`String`	`getFamily()`
`String`	`getIcon()` The icon to be displayed with the menu item
`String`	`getIconDisabled()` The icon to be displayed with the menu item when it is disabled
`Object`	`getLabel()` The text label for the menu item.
`String`	`getLang()` Code describing the language used in the generated markup for this component.
`Mode`	`getMode()` Determines how the menu item requests are submitted.
`String`	`getOnbeforedomupdate()` The client-side script method to be called after the ajax response comes back, but before the DOM is updated
`String`	`getOnbegin()` The client-side script method to be called before an ajax request.
`String`	`getOnclick()` Javascript code executed when a pointer button is clicked over this element.
`String`	`getOncomplete()` The client-side script method to be called after the DOM is updated
`String`	`getOndblclick()` Javascript code executed when a pointer button is double clicked over this element.
`String`	`getOnkeydown()` Javascript code executed when a key is pressed down over this element.
`String`	`getOnkeypress()` Javascript code executed when a key is pressed and released over this element.
`String`	`getOnkeyup()` Javascript code executed when a key is released over this element.
`String`	`getOnmousedown()` Javascript code executed when a pointer button is pressed down over this element.
`String`	`getOnmousemove()` Javascript code executed when a pointer button is moved within this element.
`String`	`getOnmouseout()` Javascript code executed when a pointer button is moved away from this element.
`String`	`getOnmouseover()` Javascript code executed when a pointer button is moved onto this element.
`String`	`getOnmouseup()` Javascript code executed when a pointer button is released over this element.
`Object`	`getRender()` IDs of components that will participate in the "render" portion of the Request Processing Lifecycle.
`String`	`getStatus()` Name of the request status component that will indicate the status of the Ajax request
`String`	`getStyle()` CSS style(s) to be applied when this component is rendered.
`String`	`getStyleClass()` Space-separated list of CSS style class(es) to be applied when this element is rendered.
`String`	`getTitle()` Advisory title information about markup elements generated for this component.
`Object`	`getValue()`
`boolean`	`isBypassUpdates()` If "true", after process validations phase it skips updates of model beans on a force render response.
`boolean`	`isDisabled()` Flag indicating that this element must never receive focus or be included in a subsequent submit.
`boolean`	`isLimitRender()` If "true", render only those ids specified in the "render" attribute, forgoing the render of the auto-rendered panels
`boolean`	`isResetValues()` If true, indicate that this particular Ajax transaction is a value reset transaction.
`void`	`setBypassUpdates(boolean bypassUpdates)`
`void`	`setData(Object data)`
`void`	`setDir(String dir)`
`void`	`setDisabled(boolean disabled)`
`void`	`setExecute(Object execute)`
`void`	`setIcon(String icon)`
`void`	`setIconDisabled(String iconDisabled)`
`void`	`setLabel(Object label)`
`void`	`setLang(String lang)`
`void`	`setLimitRender(boolean limitRender)`
`void`	`setMode(Mode mode)`
`void`	`setOnbeforedomupdate(String onbeforedomupdate)`
`void`	`setOnbegin(String onbegin)`
`void`	`setOnclick(String onclick)`
`void`	`setOncomplete(String oncomplete)`
`void`	`setOndblclick(String ondblclick)`
`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`	`setRender(Object render)`
`void`	`setResetValues(boolean resetValues)`
`void`	`setStatus(String status)`
`void`	`setStyle(String style)`
`void`	`setStyleClass(String styleClass)`
`void`	`setTitle(String title)`
`void`	`setValue(Object value)`

Methods inherited from class org.richfaces.component.AbstractMenuItem
getCssRoot

Methods inherited from class org.richfaces.component.AbstractActionComponent
queueEvent

Methods inherited from class javax.faces.component.UICommand
addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, isImmediate, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate

Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, clearInitialState, decode, 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

- 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
  - 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
  - isBypassUpdates
```
public boolean isBypassUpdates()
```
    Description copied from interface: BypassProps
    
    If "true", after process validations phase it skips updates of model beans on a force render response. It can be used for validating components input.
    
    Specified by:
    
    isBypassUpdates in interface BypassProps
  - setBypassUpdates
```
public void setBypassUpdates(boolean bypassUpdates)
```
  - getData
```
public Object getData()
```
    Description copied from interface: AjaxActivatorProps
    
    Serialized (on default with JSON) data passed to the client by a developer on an AJAX request. It's accessible via "event.data" syntax. Both primitive types and complex types such as arrays and collections can be serialized and used with data
    
    Specified by:
    
    getData in interface AjaxActivatorProps
  - setData
```
public void setData(Object data)
```
  - getDir
```
public String getDir()
```
    Description copied from interface: I18nProps
    
    Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left).
    
    Specified by:
    
    getDir in interface I18nProps
  - setDir
```
public void setDir(String dir)
```
  - isDisabled
```
public boolean isDisabled()
```
    Description copied from interface: DisabledProps
    
    Flag indicating that this element must never receive focus or be included in a subsequent submit.
    
    Specified by:
    
    isDisabled in interface DisabledProps
  - setDisabled
```
public void setDisabled(boolean disabled)
```
  - getExecute
```
public Object getExecute()
```
    Description copied from interface: AjaxProps
    
    IDs of components that will participate in the "execute" portion of the Request Processing Lifecycle. Can be a single ID, a space or comma separated list of IDs, or an EL Expression evaluating to an array or Collection. Any of the keywords "@this", "@form", "@all", "@none", "@region" may be specified in the identifier list. Some components make use of additional keywords
    
    Specified by:
    
    getExecute in interface AjaxProps
  - setExecute
```
public void setExecute(Object execute)
```
  - getIcon
```
public String getIcon()
```
    Description copied from class: AbstractMenuItem
    
    The icon to be displayed with the menu item
    
    Specified by:
    
    getIcon in class AbstractMenuItem
  - setIcon
```
public void setIcon(String icon)
```
  - getIconDisabled
```
public String getIconDisabled()
```
    Description copied from class: AbstractMenuItem
    
    The icon to be displayed with the menu item when it is disabled
    
    Specified by:
    
    getIconDisabled in class AbstractMenuItem
  - setIconDisabled
```
public void setIconDisabled(String iconDisabled)
```
  - getLabel
```
public Object getLabel()
```
    Description copied from class: AbstractMenuItem
    
    The text label for the menu item. Alternatively, use the label facet to define content for the label
    
    Default is server
    
    Specified by:
    
    getLabel in class AbstractMenuItem
  - setLabel
```
public void setLabel(Object label)
```
  - getLang
```
public String getLang()
```
    Description copied from interface: I18nProps
    
    Code describing the language used in the generated markup for this component.
    
    Specified by:
    
    getLang in interface I18nProps
  - setLang
```
public void setLang(String lang)
```
  - isLimitRender
```
public boolean isLimitRender()
```
    Description copied from interface: AjaxActivatorProps
    
    If "true", render only those ids specified in the "render" attribute, forgoing the render of the auto-rendered panels
    
    Specified by:
    
    isLimitRender in interface AjaxActivatorProps
  - setLimitRender
```
public void setLimitRender(boolean limitRender)
```
  - getMode
```
public Mode getMode()
```
    Description copied from class: AbstractMenuItem
    Determines how the menu item requests are submitted. Valid values:
    1. server, the default setting, submits the form normally and completely refreshes the page.
    2. ajax performs an Ajax form submission, and re-renders elements specified with the render attribute.
    3. client causes the action and actionListener items to be ignored, and the behavior is fully defined by the nested components instead of responses from submissions
    Specified by:
    
    getMode in class AbstractMenuItem
  - setMode
```
public void setMode(Mode mode)
```
  - getOnbeforedomupdate
```
public String getOnbeforedomupdate()
```
    Description copied from interface: AjaxActivatorProps
    
    The client-side script method to be called after the ajax response comes back, but before the DOM is updated
    
    Specified by:
    
    getOnbeforedomupdate in interface AjaxActivatorProps
  - setOnbeforedomupdate
```
public void setOnbeforedomupdate(String onbeforedomupdate)
```
  - getOnbegin
```
public String getOnbegin()
```
    Description copied from interface: AjaxProps
    
    The client-side script method to be called before an ajax request.
    
    Specified by:
    
    getOnbegin in interface AjaxProps
  - setOnbegin
```
public void setOnbegin(String onbegin)
```
  - getOnclick
```
public String getOnclick()
```
    Description copied from interface: EventsMouseProps
    
    Javascript code executed when a pointer button is clicked over this element.
    
    Specified by:
    
    getOnclick in interface EventsMouseProps
  - setOnclick
```
public void setOnclick(String onclick)
```
  - getOncomplete
```
public String getOncomplete()
```
    Description copied from interface: AjaxActivatorProps
    
    The client-side script method to be called after the DOM is updated
    
    Specified by:
    
    getOncomplete in interface AjaxActivatorProps
  - setOncomplete
```
public void setOncomplete(String oncomplete)
```
  - getOndblclick
```
public String getOndblclick()
```
    Description copied from interface: EventsMouseProps
    
    Javascript code executed when a pointer button is double clicked over this element.
    
    Specified by:
    
    getOndblclick in interface EventsMouseProps
  - setOndblclick
```
public void setOndblclick(String ondblclick)
```
  - getOnkeydown
```
public String getOnkeydown()
```
    Description copied from interface: EventsKeyProps
    
    Javascript code executed when a key is pressed down over this element.
    
    Specified by:
    
    getOnkeydown in interface EventsKeyProps
  - setOnkeydown
```
public void setOnkeydown(String onkeydown)
```
  - getOnkeypress
```
public String getOnkeypress()
```
    Description copied from interface: EventsKeyProps
    
    Javascript code executed when a key is pressed and released over this element.
    
    Specified by:
    
    getOnkeypress in interface EventsKeyProps
  - setOnkeypress
```
public void setOnkeypress(String onkeypress)
```
  - getOnkeyup
```
public String getOnkeyup()
```
    Description copied from interface: EventsKeyProps
    
    Javascript code executed when a key is released over this element.
    
    Specified by:
    
    getOnkeyup in interface EventsKeyProps
  - setOnkeyup
```
public void setOnkeyup(String onkeyup)
```
  - getOnmousedown
```
public String getOnmousedown()
```
    Description copied from interface: EventsMouseProps
    
    Javascript code executed when a pointer button is pressed down over this element.
    
    Specified by:
    
    getOnmousedown in interface EventsMouseProps
  - setOnmousedown
```
public void setOnmousedown(String onmousedown)
```
  - getOnmousemove
```
public String getOnmousemove()
```
    Description copied from interface: EventsMouseProps
    
    Javascript code executed when a pointer button is moved within this element.
    
    Specified by:
    
    getOnmousemove in interface EventsMouseProps
  - setOnmousemove
```
public void setOnmousemove(String onmousemove)
```
  - getOnmouseout
```
public String getOnmouseout()
```
    Description copied from interface: EventsMouseProps
    
    Javascript code executed when a pointer button is moved away from this element.
    
    Specified by:
    
    getOnmouseout in interface EventsMouseProps
  - setOnmouseout
```
public void setOnmouseout(String onmouseout)
```
  - getOnmouseover
```
public String getOnmouseover()
```
    Description copied from interface: EventsMouseProps
    
    Javascript code executed when a pointer button is moved onto this element.
    
    Specified by:
    
    getOnmouseover in interface EventsMouseProps
  - setOnmouseover
```
public void setOnmouseover(String onmouseover)
```
  - getOnmouseup
```
public String getOnmouseup()
```
    Description copied from interface: EventsMouseProps
    
    Javascript code executed when a pointer button is released over this element.
    
    Specified by:
    
    getOnmouseup in interface EventsMouseProps
  - setOnmouseup
```
public void setOnmouseup(String onmouseup)
```
  - getRender
```
public Object getRender()
```
    Description copied from interface: AjaxActivatorProps
    
    IDs of components that will participate in the "render" portion of the Request Processing Lifecycle. Can be a single ID, a space or comma separated list of Id's, or an EL Expression evaluating to an array or Collection. Any of the keywords "@this", "@form", "@all", "@none", "@region" may be specified in the identifier list. Some components make use of additional keywords
    
    Specified by:
    
    getRender in interface AjaxActivatorProps
  - setRender
```
public void setRender(Object render)
```
  - isResetValues
```
public boolean isResetValues()
```
    Description copied from interface: AjaxActivatorProps
    
    If true, indicate that this particular Ajax transaction is a value reset transaction. This will cause resetValue() to be called on any EditableValueHolder instances encountered as a result of this ajax transaction. If not specified, or the value is false, no such indication is made.
    
    Specified by:
    
    isResetValues in interface AjaxActivatorProps
  - setResetValues
```
public void setResetValues(boolean resetValues)
```
  - getStatus
```
public String getStatus()
```
    Description copied from interface: AjaxProps
    
    Name of the request status component that will indicate the status of the Ajax request
    
    Specified by:
    
    getStatus in interface AjaxProps
  - setStatus
```
public void setStatus(String status)
```
  - getStyle
```
public String getStyle()
```
    Description copied from interface: CoreProps
    
    CSS style(s) to be applied when this component is rendered.
    
    Specified by:
    
    getStyle in interface CoreProps
  - setStyle
```
public void setStyle(String style)
```
  - getStyleClass
```
public String getStyleClass()
```
    Description copied from interface: CoreProps
    
    Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.
    
    Specified by:
    
    getStyleClass in interface CoreProps
  - setStyleClass
```
public void setStyleClass(String styleClass)
```
  - getTitle
```
public String getTitle()
```
    Description copied from interface: CoreProps
    
    Advisory title information about markup elements generated for this component.
    
    Specified by:
    
    getTitle in interface CoreProps
  - setTitle
```
public void setTitle(String title)
```
  - getValue
```
public Object getValue()
```
    Specified by:
    
    getValue in class AbstractMenuItem
  - setValue
```
public void setValue(Object value)
```
    Overrides:
    
    setValue in class javax.faces.component.UICommand

Class UIMenuItem

Nested Class Summary

Nested classes/interfaces inherited from class org.richfaces.component.AbstractMenuItem

Field Summary

Fields inherited from class org.richfaces.component.AbstractMenuItem

Fields inherited from class javax.faces.component.UIComponent

Constructor Summary

Method Summary

Methods inherited from class org.richfaces.component.AbstractMenuItem

Methods inherited from class org.richfaces.component.AbstractActionComponent

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 javax.faces.component.behavior.ClientBehaviorHolder

Field Detail

COMPONENT_TYPE

COMPONENT_FAMILY

Constructor Detail

UIMenuItem

Method Detail

getFamily

getEventNames

getDefaultEventName

isBypassUpdates

setBypassUpdates

getData

setData

getDir

setDir

isDisabled

setDisabled

getExecute

setExecute

getIcon

setIcon

getIconDisabled

setIconDisabled

getLabel

setLabel

getLang

setLang

isLimitRender

setLimitRender

getMode

setMode

getOnbeforedomupdate

setOnbeforedomupdate

getOnbegin

setOnbegin

getOnclick

setOnclick

getOncomplete

setOncomplete

getOndblclick

setOndblclick

getOnkeydown

setOnkeydown

getOnkeypress

setOnkeypress

getOnkeyup

setOnkeyup

getOnmousedown

setOnmousedown

getOnmousemove

setOnmousemove

getOnmouseout

setOnmouseout

getOnmouseover

setOnmouseover

getOnmouseup

setOnmouseup

getRender

setRender

isResetValues

setResetValues

getStatus

setStatus

getStyle

setStyle