org.apache.myfaces.tobago.component
Class UIMenuCommand

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UICommand
              org.apache.myfaces.tobago.internal.component.AbstractUICommandBase
                  org.apache.myfaces.tobago.internal.component.AbstractUICommand
                      org.apache.myfaces.tobago.component.UICommand
                          org.apache.myfaces.tobago.component.UIMenuCommand

All Implemented Interfaces:

javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.StateHolder, SupportsMarkup, SupportsRenderedPartially, Configurable, LayoutBase, LayoutComponent

Direct Known Subclasses:

UIMenuItem

public class UIMenuCommand
extends UICommand

Renders a menu item. UIComponent class, generated from template component1.2.stg with class MenuCommandTagDeclaration.

Field Summary

static String

COMPONENT_TYPE

Fields inherited from class javax.faces.component.UICommand

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponent

bindings

Constructor Summary

UIMenuCommand()

Method Summary

Character	getAccessKey() Deprecated.
String	getImage() Url to an image to display.
String	getLabel() Text value to display as label.
String	getLabelWithAccessKey() Deprecated.
boolean	isDisabled() Flag indicating that this element is disabled.
boolean	isImmediate() Flag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.
boolean	isJsfResource() Flag indicating that the resource referenced by the resource attribute is a jsf resource.
boolean	isTransition() Specify, if the command calls an JSF-Action.
void	restoreState(javax.faces.context.FacesContext context, Object componentState)
Object	saveState(javax.faces.context.FacesContext context)
void	setAccessKey(Character accessKey) Deprecated.
void	setDisabled(boolean disabled)
void	setImage(String image)
void	setImmediate(boolean immediate)
void	setJsfResource(boolean jsfResource)
void	setLabel(String label)
void	setLabelWithAccessKey(String labelWithAccessKey) Deprecated.
void	setTransition(boolean transition)

Methods inherited from class org.apache.myfaces.tobago.component.UICommand

getColumnSpan, getCurrentHeight, getCurrentMarkup, getCurrentWidth, getDisplay, getHeight, getHorizontalIndex, getLeft, getLink, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMarkup, getMaximumHeight, getMaximumWidth, getMinimumHeight, getMinimumWidth, getOnclick, getPreferredHeight, getPreferredWidth, getRenderedPartially, getResource, getRowSpan, getTarget, getTop, getVerticalIndex, getWidth, setColumnSpan, setCurrentHeight, setCurrentMarkup, setCurrentWidth, setDisplay, setHeight, setHorizontalIndex, setLeft, setLink, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMarkup, setMaximumHeight, setMaximumWidth, setMinimumHeight, setMinimumWidth, setOnclick, setPreferredHeight, setPreferredWidth, setRenderedPartially, setResource, setRowSpan, setTarget, setTop, setVerticalIndex, setWidth

Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUICommandBase

processDecodes, queueEvent

Methods inherited from class javax.faces.component.UICommand

addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getFamily, getValue, removeActionListener, setAction, setActionExpression, setActionListener, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId, getValueExpression, setValueExpression

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.myfaces.tobago.layout.LayoutComponent

isRendered

Methods inherited from interface org.apache.myfaces.tobago.config.Configurable

getRendererType

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

UIMenuCommand

public UIMenuCommand()

Method Detail

getAccessKey

@Deprecated
public Character getAccessKey()

Deprecated.

Deprecated! Has not longer any function.

setAccessKey

@Deprecated
public void setAccessKey(Character accessKey)

Deprecated.

getLabelWithAccessKey

@Deprecated
public String getLabelWithAccessKey()

Deprecated.

Deprecated! Use 'label' instead. Text value to display as label. If text contains an underscore the next character overwrites 'accesskey'.

setLabelWithAccessKey

@Deprecated
public void setLabelWithAccessKey(String labelWithAccessKey)

Deprecated.

isJsfResource

public boolean isJsfResource()

Flag indicating that the resource referenced by the resource attribute is a jsf resource. That means that the url has to be processed to change the prefix or suffix (e. g. *.jsf or /faces/*). Default is false.
Default: false

Overrides:

isJsfResource in class UICommand

setJsfResource

public void setJsfResource(boolean jsfResource)

Overrides:

setJsfResource in class UICommand

getImage

public String getImage()

Url to an image to display.

setImage

public void setImage(String image)

isTransition

public boolean isTransition()

Specify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.
Default: true

Overrides:

isTransition in class UICommand

setTransition

public void setTransition(boolean transition)

Overrides:

setTransition in class UICommand

getLabel

public String getLabel()

Text value to display as label. If text contains an underscore the next character is used as accesskey.

setLabel

public void setLabel(String label)

isImmediate

public boolean isImmediate()

Flag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.
Default: false

Specified by:

isImmediate in interface javax.faces.component.ActionSource

Overrides:

isImmediate in class UICommand

setImmediate

public void setImmediate(boolean immediate)

Specified by:

setImmediate in interface javax.faces.component.ActionSource

Overrides:

setImmediate in class UICommand

isDisabled

public boolean isDisabled()

Flag indicating that this element is disabled.
Default: false

Overrides:

isDisabled in class UICommand

setDisabled

public void setDisabled(boolean disabled)

Overrides:

setDisabled in class UICommand

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         Object componentState)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class UICommand

saveState

public Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class UICommand