org.apache.myfaces.tobago.component
Class UICommand

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UICommand
              extended by org.apache.myfaces.tobago.internal.component.AbstractUICommandBase
                  extended by org.apache.myfaces.tobago.internal.component.AbstractUICommand
                      extended by org.apache.myfaces.tobago.component.UICommand
All Implemented Interfaces:
javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.StateHolder, SupportsMarkup, SupportsRenderedPartially, Configurable, LayoutBase, LayoutComponent
Direct Known Subclasses:
UIButton, UIMenuCommand, UISelectBooleanCommand, UISelectOneCommand

public class UICommand
extends AbstractUICommand
implements SupportsMarkup

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 CommandTagDeclaration.


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
UICommand()
           
 
Method Summary
 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(javax.faces.context.FacesContext context, Object componentState)
           
 Object saveState(javax.faces.context.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)
           
 
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

UICommand

public UICommand()
Method Detail

getMarkup

public Markup getMarkup()
Specified by:
getMarkup in interface SupportsMarkup

setMarkup

public void setMarkup(Markup markup)
Specified by:
setMarkup in interface SupportsMarkup

getMarginLeft

public Measure getMarginLeft()
Specified by:
getMarginLeft in interface LayoutBase

setMarginLeft

public void setMarginLeft(Measure marginLeft)
Specified by:
setMarginLeft in interface LayoutBase

getLink

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
Starts with protocol followed by a colon ':' character. The link will not be modified.
internal relative link
Any other strings. A session id will be added, if needed.

Specified by:
getLink in class AbstractUICommandBase

setLink

public void setLink(String link)

getMinimumHeight

public Measure getMinimumHeight()
Specified by:
getMinimumHeight in interface LayoutBase

setMinimumHeight

public void setMinimumHeight(Measure minimumHeight)
Specified by:
setMinimumHeight in interface LayoutBase

getHeight

public Measure getHeight()
This value will usually be set by the layout manager.

Specified by:
getHeight in interface LayoutBase

setHeight

public void setHeight(Measure height)
Specified by:
setHeight in interface LayoutBase

getMinimumWidth

public Measure getMinimumWidth()
Specified by:
getMinimumWidth in interface LayoutBase

setMinimumWidth

public void setMinimumWidth(Measure minimumWidth)
Specified by:
setMinimumWidth in interface LayoutBase

getRowSpan

public Integer getRowSpan()
Specified by:
getRowSpan in interface LayoutComponent

setRowSpan

public void setRowSpan(Integer rowSpan)
Specified by:
setRowSpan in interface LayoutComponent

getLeft

public Measure getLeft()
This value will usually be set by the layout manager.

Specified by:
getLeft in interface LayoutBase

setLeft

public void setLeft(Measure left)
Specified by:
setLeft in interface LayoutBase

getColumnSpan

public Integer getColumnSpan()
Specified by:
getColumnSpan in interface LayoutComponent

setColumnSpan

public void setColumnSpan(Integer columnSpan)
Specified by:
setColumnSpan in interface LayoutComponent

getTop

public Measure getTop()
This value will usually be set by the layout manager.

Specified by:
getTop in interface LayoutBase

setTop

public void setTop(Measure top)
Specified by:
setTop in interface LayoutBase

getMaximumHeight

public Measure getMaximumHeight()
Specified by:
getMaximumHeight in interface LayoutBase

setMaximumHeight

public void setMaximumHeight(Measure maximumHeight)
Specified by:
setMaximumHeight in interface LayoutBase

getCurrentWidth

public Measure getCurrentWidth()
This value will usually be set by the layout manager. It holds the current width computed by the layout manager.

Specified by:
getCurrentWidth in interface LayoutBase

setCurrentWidth

public void setCurrentWidth(Measure currentWidth)
Specified by:
setCurrentWidth in interface LayoutBase

getMarginTop

public Measure getMarginTop()
Specified by:
getMarginTop in interface LayoutBase

setMarginTop

public void setMarginTop(Measure marginTop)
Specified by:
setMarginTop in interface LayoutBase

getWidth

public Measure getWidth()
This value will usually be set by the layout manager.

Specified by:
getWidth in interface LayoutBase

setWidth

public void setWidth(Measure width)
Specified by:
setWidth in interface LayoutBase

getMarginRight

public Measure getMarginRight()
Specified by:
getMarginRight in interface LayoutBase

setMarginRight

public void setMarginRight(Measure marginRight)
Specified by:
setMarginRight in interface LayoutBase

getPreferredHeight

public Measure getPreferredHeight()
Specified by:
getPreferredHeight in interface LayoutBase

setPreferredHeight

public void setPreferredHeight(Measure preferredHeight)
Specified by:
setPreferredHeight in interface LayoutBase

getResource

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.

Specified by:
getResource in class AbstractUICommandBase

setResource

public void setResource(String resource)

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

Specified by:
isJsfResource in class AbstractUICommandBase

setJsfResource

public void setJsfResource(boolean jsfResource)

getCurrentHeight

public Measure getCurrentHeight()
This value will usually be set by the layout manager. It holds the current height computed by the layout manager.

Specified by:
getCurrentHeight in interface LayoutBase

setCurrentHeight

public void setCurrentHeight(Measure currentHeight)
Specified by:
setCurrentHeight in interface LayoutBase

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


setTransition

public void setTransition(boolean transition)

getDisplay

public Display getDisplay()
This attribute is for internal use only.

Specified by:
getDisplay in interface LayoutComponent

setDisplay

public void setDisplay(Display display)
Specified by:
setDisplay in interface LayoutComponent

getMaximumWidth

public Measure getMaximumWidth()
Specified by:
getMaximumWidth in interface LayoutBase

setMaximumWidth

public void setMaximumWidth(Measure maximumWidth)
Specified by:
setMaximumWidth in interface LayoutBase

getPreferredWidth

public Measure getPreferredWidth()
Specified by:
getPreferredWidth in interface LayoutBase

setPreferredWidth

public void setPreferredWidth(Measure preferredWidth)
Specified by:
setPreferredWidth in interface LayoutBase

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

setImmediate

public void setImmediate(boolean immediate)
Specified by:
setImmediate in interface javax.faces.component.ActionSource
Overrides:
setImmediate in class javax.faces.component.UICommand

getMarginBottom

public Measure getMarginBottom()
Specified by:
getMarginBottom in interface LayoutBase

setMarginBottom

public void setMarginBottom(Measure marginBottom)
Specified by:
setMarginBottom in interface LayoutBase

getVerticalIndex

public Integer getVerticalIndex()
This attribute is for internal use only.

Specified by:
getVerticalIndex in interface LayoutComponent

setVerticalIndex

public void setVerticalIndex(Integer verticalIndex)
Specified by:
setVerticalIndex in interface LayoutComponent

getCurrentMarkup

public Markup getCurrentMarkup()
Specified by:
getCurrentMarkup in interface SupportsMarkup
Specified by:
getCurrentMarkup in interface Configurable

setCurrentMarkup

public void setCurrentMarkup(Markup currentMarkup)
Specified by:
setCurrentMarkup in interface SupportsMarkup

getRenderedPartially

public String[] getRenderedPartially()
Indicate the partially rendered Components in a case of a submit.

Specified by:
getRenderedPartially in interface SupportsRenderedPartially

setRenderedPartially

public void setRenderedPartially(String[] renderedPartially)
Specified by:
setRenderedPartially in interface SupportsRenderedPartially

getTarget

public String getTarget()
Name of a frame where the resource retrieved via this hyperlink is to be displayed.

Specified by:
getTarget in class AbstractUICommandBase

setTarget

public void setTarget(String target)

getOnclick

public String getOnclick()
Script to be invoked when clicked

Specified by:
getOnclick in class AbstractUICommandBase

setOnclick

public void setOnclick(String onclick)

getHorizontalIndex

public Integer getHorizontalIndex()
This attribute is for internal use only.

Specified by:
getHorizontalIndex in interface LayoutComponent

setHorizontalIndex

public void setHorizontalIndex(Integer horizontalIndex)
Specified by:
setHorizontalIndex in interface LayoutComponent

isDisabled

public boolean isDisabled()
Flag indicating that this element is disabled.
Default: false


setDisabled

public void setDisabled(boolean disabled)

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         Object componentState)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class javax.faces.component.UICommand

saveState

public Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class javax.faces.component.UICommand


Copyright © 2002-2014 The Apache Software Foundation. All Rights Reserved.