com.ibm.xsp.component
Class UICommandButton

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UICommand
              com.ibm.xsp.component.UICommandEx2
                  com.ibm.xsp.component.UICommandButton

All Implemented Interfaces:

FacesAttrsObject, com.ibm.xsp.component.FacesNavigationBehaviour, FacesSaveBehaviour, FacesDojoComponent, ThemeControl, javax.faces.component.ActionSource, javax.faces.component.StateHolder

Direct Known Subclasses:

XspCommandButton

public class UICommandButton
extends UICommandEx2
implements FacesDojoComponent, ThemeControl, FacesAttrsObject

Not intended to be subclassed.

Nested Class Summary

Nested classes/interfaces inherited from class javax.faces.component.UIComponentBase

javax.faces.component.UIComponentBase.AggregatedIterator, javax.faces.component.UIComponentBase.UnmodifiableIterator

Nested classes/interfaces inherited from class javax.faces.component.UIComponent

javax.faces.component.UIComponent.StateMap, javax.faces.component.UIComponent.StateMapEntry

Field Summary

static java.lang.String	COMPONENT_TYPE
static java.lang.String	TYPE_BUTTON
static java.lang.String	TYPE_DEFAULT
static java.lang.String	TYPE_RESET
static java.lang.String	TYPE_SUBMIT

Fields inherited from class com.ibm.xsp.component.UICommandEx2

COMPONENT_FAMILY, EXEC_COMPLETE, EXEC_PARTIAL, MODE_COMPLETE, MODE_NOREFRESH, MODE_PARTIAL

Fields inherited from class javax.faces.component.UIComponentBase

EMPTY_ITERATOR

Fields inherited from class javax.faces.component.UIComponent

_xspStateId

Constructor Summary

UICommandButton()

Method Summary

void	addAttr(Attr attr) Add an Attr, to appear as an attribute in the HTML output of this control or object tag.
void	addDojoAttribute(DojoAttribute attribute) Add a dojo attribute to the set associated with this property.
java.util.List<Attr>	getAttrs() The extra attributes to be output on the base element at the root of this control or object tag.
java.util.List<DojoAttribute>	getDojoAttributes() Return the value of the dojoAttributes property.
java.lang.String	getDojoType() Return the value of the dojoType property.
java.lang.String	getStyleKitFamily() The styleKitFamily is basically the default themeId, to use if the "themeId" property is not set on this control instance in the XPage source.
java.lang.String	getType() Returns the button type to be rendered.
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setAttrs(java.util.List<Attr> attrs) This method is not used by the XPage generated .java file - instead the addAttr(Attr) method is used to add attributes to the list.
void	setDojoAttributes(java.util.List<DojoAttribute> dojoAttributes) Set the value of the dojoAttributes property.
void	setDojoType(java.lang.String dojoType) Set the value of the dojoType property.
void	setType(java.lang.String type) Set the button type.

Methods inherited from class com.ibm.xsp.component.UICommandEx2

doNavigation, doSave, encodeBegin, getExecId, getExecMode, getFamily, getOnComplete, getOnError, getOnStart, getRefreshId, getRefreshMode, isDisableValidators, isNavigate, isPartialRefresh, isSave, setDisableValidators, setExecId, setExecMode, setNavigate, setOnComplete, setOnError, setOnStart, setRefreshId, setRefreshMode, setSave

Methods inherited from class javax.faces.component.UICommand

addActionListener, broadcast, getAction, getActionListener, getActionListeners, getValue, isImmediate, queueEvent, removeActionListener, setAction, setActionListener, setImmediate, setValue

Methods inherited from class javax.faces.component.UIComponentBase

_xspCleanTransientData, _xspGetReadOnlyObj, _xspGetRendererData, _xspRemoveReadOnlyObj, _xspRemoveRendererData, _xspSetIdUnchecked, _xspSetReadOnlyObj, _xspSetRendererData, addFacesListener, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

_xspGetStateId, _xspGetStateMap, _xspRestoreAttribute, _xspRestoreState, _xspSaveState, invokeOnComponent, isVisitable, markInitialState, setControlState, visitTree

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

TYPE_SUBMIT

public static final java.lang.String TYPE_SUBMIT

See Also:

Constant Field Values

TYPE_RESET

public static final java.lang.String TYPE_RESET

See Also:

Constant Field Values

TYPE_BUTTON

public static final java.lang.String TYPE_BUTTON

See Also:

Constant Field Values

TYPE_DEFAULT

public static final java.lang.String TYPE_DEFAULT

See Also:

Constant Field Values

Constructor Detail

UICommandButton

public UICommandButton()

Method Detail

getStyleKitFamily

public java.lang.String getStyleKitFamily()

Description copied from interface: ThemeControl

The styleKitFamily is basically the default themeId, to use if the "themeId" property is not set on this control instance in the XPage source. For example, "InputField.EditBox" is used for most Edit Box controls. See Domino/xsp/nsf/themes/webstandard.theme for more examples.

The implementation may return different values depending on the configuration of the current control, for example the Button control returns a different value and looks different when it is configured as a cancel button.

Specified by:

getStyleKitFamily in interface ThemeControl

Returns:

a non-null themeId corresponding to the configuration for this type of control in a theme file.

getType

public java.lang.String getType()

Returns the button type to be rendered. Can be of type button, submit or reset. If no value is set the button will default to type "button" which will require client side JavaScript to be of any use. Typically the XspEventHandler is used to control the buttons behavior.

Returns:

Button Type.

setType

public void setType(java.lang.String type)

Set the button type.

Parameters:

button - type.

getDojoType

public java.lang.String getDojoType()

Return the value of the dojoType property. Contents:

Sets the default Dojo Type used to create this control in the browser.

Specified by:

getDojoType in interface FacesDojoComponent

setDojoType

public void setDojoType(java.lang.String dojoType)

Set the value of the dojoType property.

getDojoAttributes

public java.util.List<DojoAttribute> getDojoAttributes()

Return the value of the dojoAttributes property. Contents:

A list of Dojo attributes

Specified by:

getDojoAttributes in interface FacesDojoComponent

addDojoAttribute

public void addDojoAttribute(DojoAttribute attribute)

Add a dojo attribute to the set associated with this property.

Parameters:

action -

setDojoAttributes

public void setDojoAttributes(java.util.List<DojoAttribute> dojoAttributes)

Set the value of the dojoAttributes property.

getAttrs

public java.util.List<Attr> getAttrs()

The extra attributes to be output on the base element at the root of this control or object tag. This should only be used when none of the properties in the All Properties pane correspond to the desired attribute. This may return null. The addAttr(Attr) method should be used to add an Attr.

Specified by:

getAttrs in interface FacesAttrsObject

addAttr

public void addAttr(Attr attr)

Add an Attr, to appear as an attribute in the HTML output of this control or object tag.

Specified by:

addAttr in interface FacesAttrsObject

Parameters:

action -

setAttrs

public void setAttrs(java.util.List<Attr> attrs)

This method is not used by the XPage generated .java file - instead the addAttr(Attr) method is used to add attributes to the list.

saveState

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

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class UICommandEx2

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class UICommandEx2