public class

UICommand

extends AbstractUICommand
implements SupportsMarkup
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
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Use this tag only as a facet for click, change in selectOneRadio, selectBooleanCheckbox, selectManyCheckbox and selectOneChoice UIComponent class, generated from template component1.2.stg with class org.apache.myfaces.tobago.internal.taglib.component.CommandTagDeclaration.

Summary

Constants
String COMPONENT_TYPE
[Expand]
Inherited Constants
From class javax.faces.component.UICommand
[Expand]
Inherited Fields
From class javax.faces.component.UIComponent
Public Constructors
UICommand()
Public Methods
Integer getColumnSpan()
Measure getCurrentHeight()
This value will usually be set by the layout manager.
Markup getCurrentMarkup()
Measure getCurrentWidth()
This value will usually be set by the layout manager.
Display getDisplay()
This attribute is for internal use only.
Measure getHeight()
This value will usually be set by the layout manager.
Integer getHorizontalIndex()
This attribute is for internal use only.
Measure getLeft()
This value will usually be set by the layout manager.
String getLink()
Link to an arbitrary URL, either an internal link or an external link.
Measure getMarginBottom()
Measure getMarginLeft()
Measure getMarginRight()
Measure getMarginTop()
Markup getMarkup()
Measure getMaximumHeight()
Measure getMaximumWidth()
Measure getMinimumHeight()
Measure getMinimumWidth()
String getOnclick()
Script to be invoked when clicked
Measure getPreferredHeight()
Measure getPreferredWidth()
String[] getRenderedPartially()
Indicate the partially rendered Components in a case of a submit.
String getResource()
Link to an internal resource.
Integer getRowSpan()
String getTarget()
Name of a frame where the resource retrieved via this hyperlink is to be displayed.
Measure getTop()
This value will usually be set by the layout manager.
Integer getVerticalIndex()
This attribute is for internal use only.
Measure getWidth()
This value will usually be set by the layout manager.
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(FacesContext context, Object componentState)
Object saveState(FacesContext context)
void setColumnSpan(Integer columnSpan)
void setCurrentHeight(Measure currentHeight)
void setCurrentMarkup(Markup currentMarkup)
void setCurrentWidth(Measure currentWidth)
void setDisabled(boolean disabled)
void setDisplay(Display display)
void setHeight(Measure height)
void setHorizontalIndex(Integer horizontalIndex)
void setImmediate(boolean immediate)
void setJsfResource(boolean jsfResource)
void setLeft(Measure left)
void setLink(String link)
void setMarginBottom(Measure marginBottom)
void setMarginLeft(Measure marginLeft)
void setMarginRight(Measure marginRight)
void setMarginTop(Measure marginTop)
void setMarkup(Markup markup)
void setMaximumHeight(Measure maximumHeight)
void setMaximumWidth(Measure maximumWidth)
void setMinimumHeight(Measure minimumHeight)
void setMinimumWidth(Measure minimumWidth)
void setOnclick(String onclick)
void setPreferredHeight(Measure preferredHeight)
void setPreferredWidth(Measure preferredWidth)
void setRenderedPartially(String[] renderedPartially)
void setResource(String resource)
void setRowSpan(Integer rowSpan)
void setTarget(String target)
void setTop(Measure top)
void setTransition(boolean transition)
void setVerticalIndex(Integer verticalIndex)
void setWidth(Measure width)
[Expand]
Inherited Methods
From class org.apache.myfaces.tobago.internal.component.AbstractUICommandBase
From class javax.faces.component.UICommand
From class javax.faces.component.UIComponentBase
From class javax.faces.component.UIComponent
From class java.lang.Object
From interface javax.faces.component.ActionSource
From interface javax.faces.component.ActionSource2
From interface javax.faces.component.StateHolder
From interface org.apache.myfaces.tobago.component.SupportsMarkup
From interface org.apache.myfaces.tobago.component.SupportsRenderedPartially
From interface org.apache.myfaces.tobago.config.Configurable
From interface org.apache.myfaces.tobago.layout.LayoutBase
From interface org.apache.myfaces.tobago.layout.LayoutComponent

Constants

public static final String COMPONENT_TYPE

Constant Value: "org.apache.myfaces.tobago.Command"

Public Constructors

public UICommand ()

Public Methods

public Integer getColumnSpan ()

public Measure getCurrentHeight ()

This value will usually be set by the layout manager. It holds the current height computed by the layout manager.

public Markup getCurrentMarkup ()

public Measure getCurrentWidth ()

This value will usually be set by the layout manager. It holds the current width computed by the layout manager.

public Display getDisplay ()

This attribute is for internal use only.

public Measure getHeight ()

This value will usually be set by the layout manager.

public Integer getHorizontalIndex ()

This attribute is for internal use only.

public Measure getLeft ()

This value will usually be set by the layout manager.

public String getLink ()

Link to an arbitrary URL, either an internal link or an external link.

internal absolute link
Starts with a slash '/' character. The context path will be added. A session id will be added, if needed.
external link
Contains a colon ':' character. The link will not be modified.
internal relative link
Any other strings. A session id will be added, if needed.

public Measure getMarginBottom ()

public Measure getMarginLeft ()

public Measure getMarginRight ()

public Measure getMarginTop ()

public Markup getMarkup ()

public Measure getMaximumHeight ()

public Measure getMaximumWidth ()

public Measure getMinimumHeight ()

public Measure getMinimumWidth ()

public String getOnclick ()

Script to be invoked when clicked

public Measure getPreferredHeight ()

public Measure getPreferredWidth ()

public String[] getRenderedPartially ()

Indicate the partially rendered Components in a case of a submit.

public String getResource ()

Link to an internal resource. Resources will be processed by the resource management. E. g. define help.html and it will be served help_es.html or help_de.html if available. For JSF-Pages you have to set the jsfResource attribute.

public Integer getRowSpan ()

public String getTarget ()

Name of a frame where the resource retrieved via this hyperlink is to be displayed.

public Measure getTop ()

This value will usually be set by the layout manager.

public Integer getVerticalIndex ()

This attribute is for internal use only.

public Measure getWidth ()

This value will usually be set by the layout manager.

public boolean isDisabled ()

Flag indicating that this element is disabled.
Default: false

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

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

public boolean isTransition ()

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

public void restoreState (FacesContext context, Object componentState)

public Object saveState (FacesContext context)

public void setColumnSpan (Integer columnSpan)

public void setCurrentHeight (Measure currentHeight)

public void setCurrentMarkup (Markup currentMarkup)

public void setCurrentWidth (Measure currentWidth)

public void setDisabled (boolean disabled)

public void setDisplay (Display display)

public void setHeight (Measure height)

public void setHorizontalIndex (Integer horizontalIndex)

public void setImmediate (boolean immediate)

public void setJsfResource (boolean jsfResource)

public void setLeft (Measure left)

public void setLink (String link)

public void setMarginBottom (Measure marginBottom)

public void setMarginLeft (Measure marginLeft)

public void setMarginRight (Measure marginRight)

public void setMarginTop (Measure marginTop)

public void setMarkup (Markup markup)

public void setMaximumHeight (Measure maximumHeight)

public void setMaximumWidth (Measure maximumWidth)

public void setMinimumHeight (Measure minimumHeight)

public void setMinimumWidth (Measure minimumWidth)

public void setOnclick (String onclick)

public void setPreferredHeight (Measure preferredHeight)

public void setPreferredWidth (Measure preferredWidth)

public void setRenderedPartially (String[] renderedPartially)

public void setResource (String resource)

public void setRowSpan (Integer rowSpan)

public void setTarget (String target)

public void setTop (Measure top)

public void setTransition (boolean transition)

public void setVerticalIndex (Integer verticalIndex)

public void setWidth (Measure width)