com.ibm.xsp.component.xp
Class XspCommandButton

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UICommand
              extended by com.ibm.xsp.component.UICommandEx2
                  extended by com.ibm.xsp.component.UICommandButton
                      extended by com.ibm.xsp.component.xp.XspCommandButton
All Implemented Interfaces:
FacesAttrsObject, com.ibm.xsp.component.FacesNavigationBehaviour, FacesSaveBehaviour, FacesDojoComponent, ThemeControl, javax.faces.component.ActionSource, javax.faces.component.StateHolder

public class XspCommandButton
extends UICommandButton

A control that starts an assigned action when an event occurs, for example, a click by a user. Buttons require an event handler or JavaScript to submit data.

XPages Core Controls - Button

Represents an HTML button element


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 RENDERER_TYPE
           
 
Fields inherited from class com.ibm.xsp.component.UICommandButton
TYPE_BUTTON, TYPE_DEFAULT, TYPE_RESET, 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
XspCommandButton()
           
 
Method Summary
 java.lang.String getAccesskey()
           Return the value of the accesskey property.
 java.lang.String getDir()
           Return the value of the dir property.
 java.lang.String getDojoUsage()
           Return the value of the dojoUsage property.
 java.lang.String getIcon()
           Return the value of the icon property.
 java.lang.String getIconAlt()
           Return the value of the iconAlt property.
 java.lang.String getIconStyleClass()
           Return the value of the iconStyleClass property.
 java.lang.String getLang()
           Return the value of the lang property.
 java.lang.String getOnblur()
           Return the value of the onblur property.
 java.lang.String getOnclick()
           Return the value of the onclick property.
 java.lang.String getOndblclick()
           Return the value of the ondblclick property.
 java.lang.String getOnfocus()
           Return the value of the onfocus property.
 java.lang.String getOnkeydown()
           Return the value of the onkeydown property.
 java.lang.String getOnkeypress()
           Return the value of the onkeypress property.
 java.lang.String getOnkeyup()
           Return the value of the onkeyup property.
 java.lang.String getOnmousedown()
           Return the value of the onmousedown property.
 java.lang.String getOnmousemove()
           Return the value of the onmousemove property.
 java.lang.String getOnmouseout()
           Return the value of the onmouseout property.
 java.lang.String getOnmouseover()
           Return the value of the onmouseover property.
 java.lang.String getOnmouseup()
           Return the value of the onmouseup property.
 java.lang.String getOuterStyleClass()
           Return the value of the outerStyleClass property.
 java.lang.String getRole()
           Return the value of the role property.
 java.lang.String getStyle()
           Return the value of the style property.
 java.lang.String getStyleClass()
           Return the value of the styleClass property.
 java.lang.String getTabindex()
           Return the value of the tabindex property.
 java.lang.String getTitle()
           Return the value of the title property.
 boolean isDisabled()
           Return the value of the disabled property.
 void restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext _context)
           
 void setAccesskey(java.lang.String accesskey)
           Set the value of the accesskey property.
 void setDir(java.lang.String dir)
           Set the value of the dir property.
 void setDisabled(boolean disabled)
           Set the value of the disabled property.
 void setDojoUsage(java.lang.String dojoUsage)
           Set the value of the dojoUsage property.
 void setIcon(java.lang.String icon)
           Set the value of the icon property.
 void setIconAlt(java.lang.String iconAlt)
           Set the value of the iconAlt property.
 void setIconStyleClass(java.lang.String iconStyleClass)
           Set the value of the iconStyleClass property.
 void setLang(java.lang.String lang)
           Set the value of the lang property.
 void setOnblur(java.lang.String onblur)
           Set the value of the onblur property.
 void setOnclick(java.lang.String onclick)
           Set the value of the onclick property.
 void setOndblclick(java.lang.String ondblclick)
           Set the value of the ondblclick property.
 void setOnfocus(java.lang.String onfocus)
           Set the value of the onfocus property.
 void setOnkeydown(java.lang.String onkeydown)
           Set the value of the onkeydown property.
 void setOnkeypress(java.lang.String onkeypress)
           Set the value of the onkeypress property.
 void setOnkeyup(java.lang.String onkeyup)
           Set the value of the onkeyup property.
 void setOnmousedown(java.lang.String onmousedown)
           Set the value of the onmousedown property.
 void setOnmousemove(java.lang.String onmousemove)
           Set the value of the onmousemove property.
 void setOnmouseout(java.lang.String onmouseout)
           Set the value of the onmouseout property.
 void setOnmouseover(java.lang.String onmouseover)
           Set the value of the onmouseover property.
 void setOnmouseup(java.lang.String onmouseup)
           Set the value of the onmouseup property.
 void setOuterStyleClass(java.lang.String outerStyleClass)
           Set the value of the outerStyleClass property.
 void setRole(java.lang.String role)
           Set the value of the role property.
 void setStyle(java.lang.String style)
           Set the value of the style property.
 void setStyleClass(java.lang.String styleClass)
           Set the value of the styleClass property.
 void setTabindex(java.lang.String tabindex)
           Set the value of the tabindex property.
 void setTitle(java.lang.String title)
           Set the value of the title property.
 
Methods inherited from class com.ibm.xsp.component.UICommandButton
addAttr, addDojoAttribute, getAttrs, getDojoAttributes, getDojoType, getStyleKitFamily, getType, setAttrs, setDojoAttributes, setDojoType, setType
 
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

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE
See Also:
Constant Field Values
Constructor Detail

XspCommandButton

public XspCommandButton()
Method Detail

getAccesskey

public java.lang.String getAccesskey()

Return the value of the accesskey property. Contents:

Transfers focus to the control when pressed


getDir

public java.lang.String getDir()

Return the value of the dir property. Contents:

Specifies the direction for text that does not inherit a direction. Valid values are 'LTR' (left to right) and 'RTL' (right to left).


getDojoUsage

public java.lang.String getDojoUsage()

Return the value of the dojoUsage property. Contents:

This property is obsolete, configure the "Dojo Type" property instead. This used to determine whether the control would use Dojo.

XPages Basics Property Category - Dojo Usage


getIcon

public java.lang.String getIcon()

Return the value of the icon property. Contents:

The path to an icon displayed at the start of the button control.


getIconAlt

public java.lang.String getIconAlt()

Return the value of the iconAlt property. Contents:

Descriptive text for an icon on the button control.


getIconStyleClass

public java.lang.String getIconStyleClass()

Return the value of the iconStyleClass property. Contents:

This property is obsolete and ignored. Use the "Dojo Attributes" property instead, adding an attribute with name "iconClass"


getLang

public java.lang.String getLang()

Return the value of the lang property. Contents:

Describes the language used in the generated markup of the control.


getOnblur

public java.lang.String getOnblur()

Return the value of the onblur property. Contents:

JavaScript code executed when this control loses focus


getOnclick

public java.lang.String getOnclick()

Return the value of the onclick property. Contents:

JavaScript code executed when a pointer control is clicked over this control


getOndblclick

public java.lang.String getOndblclick()

Return the value of the ondblclick property. Contents:

JavaScript code executed when a pointer control is double clicked over this control


getOnfocus

public java.lang.String getOnfocus()

Return the value of the onfocus property. Contents:

JavaScript code executed when this control receives focus


getOnkeydown

public java.lang.String getOnkeydown()

Return the value of the onkeydown property. Contents:

JavaScript code executed when a key is pressed down over this control


getOnkeypress

public java.lang.String getOnkeypress()

Return the value of the onkeypress property. Contents:

JavaScript code executed when a key is pressed and released over this control.


getOnkeyup

public java.lang.String getOnkeyup()

Return the value of the onkeyup property. Contents:

JavaScript code executed when a key is released over this control


getOnmousedown

public java.lang.String getOnmousedown()

Return the value of the onmousedown property. Contents:

JavaScript code executed when a pointer control is pressed down over this control


getOnmousemove

public java.lang.String getOnmousemove()

Return the value of the onmousemove property. Contents:

JavaScript code executed when a pointer control is moved within this control


getOnmouseout

public java.lang.String getOnmouseout()

Return the value of the onmouseout property. Contents:

JavaScript code executed when a pointer control is moved away from this control


getOnmouseover

public java.lang.String getOnmouseover()

Return the value of the onmouseover property. Contents:

JavaScript code executed when a pointer control is moved onto this control


getOnmouseup

public java.lang.String getOnmouseup()

Return the value of the onmouseup property. Contents:

JavaScript code executed when a pointer control is released over this control


getOuterStyleClass

public java.lang.String getOuterStyleClass()

Return the value of the outerStyleClass property. Contents:

Space-separated list of CSS style class(es) to be applied when this control is rendered. When this value is set, the renderer generates an enclosing span using this style as the "class" attribute on generated markup.


getRole

public java.lang.String getRole()

Return the value of the role property. Contents:

Describes the role of the current UI element/area. It can be used by assistive technologies to determine its purpose.


getStyle

public java.lang.String getStyle()

Return the value of the style property. Contents:

Specifies CSS style(s) to be applied when this control is rendered.

XPages Styling Category - style


getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property. Contents:

Specifies the space-separated list of CSS style class(es) to be applied when this control is rendered. This value must be passed through as the "class" attribute on generated markup.


getTabindex

public java.lang.String getTabindex()

Return the value of the tabindex property. Contents:

Indicates where this control is located in the tab order of the page. Value must be an integer between 0 and 32,767. If the value is left blank, the tab order will inherit the browser's default order.


getTitle

public java.lang.String getTitle()

Return the value of the title property. Contents:

Provides title information for controls.


isDisabled

public boolean isDisabled()

Return the value of the disabled property. Contents:

Determines whether or not the page can receive focus or be included in page submissions.


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 UICommandButton

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class UICommandButton

setAccesskey

public void setAccesskey(java.lang.String accesskey)

Set the value of the accesskey property.


setDir

public void setDir(java.lang.String dir)

Set the value of the dir property.


setDisabled

public void setDisabled(boolean disabled)

Set the value of the disabled property.


setDojoUsage

public void setDojoUsage(java.lang.String dojoUsage)

Set the value of the dojoUsage property.


setIcon

public void setIcon(java.lang.String icon)

Set the value of the icon property.


setIconAlt

public void setIconAlt(java.lang.String iconAlt)

Set the value of the iconAlt property.


setIconStyleClass

public void setIconStyleClass(java.lang.String iconStyleClass)

Set the value of the iconStyleClass property.


setLang

public void setLang(java.lang.String lang)

Set the value of the lang property.


setOnblur

public void setOnblur(java.lang.String onblur)

Set the value of the onblur property.


setOnclick

public void setOnclick(java.lang.String onclick)

Set the value of the onclick property.


setOndblclick

public void setOndblclick(java.lang.String ondblclick)

Set the value of the ondblclick property.


setOnfocus

public void setOnfocus(java.lang.String onfocus)

Set the value of the onfocus property.


setOnkeydown

public void setOnkeydown(java.lang.String onkeydown)

Set the value of the onkeydown property.


setOnkeypress

public void setOnkeypress(java.lang.String onkeypress)

Set the value of the onkeypress property.


setOnkeyup

public void setOnkeyup(java.lang.String onkeyup)

Set the value of the onkeyup property.


setOnmousedown

public void setOnmousedown(java.lang.String onmousedown)

Set the value of the onmousedown property.


setOnmousemove

public void setOnmousemove(java.lang.String onmousemove)

Set the value of the onmousemove property.


setOnmouseout

public void setOnmouseout(java.lang.String onmouseout)

Set the value of the onmouseout property.


setOnmouseover

public void setOnmouseover(java.lang.String onmouseover)

Set the value of the onmouseover property.


setOnmouseup

public void setOnmouseup(java.lang.String onmouseup)

Set the value of the onmouseup property.


setOuterStyleClass

public void setOuterStyleClass(java.lang.String outerStyleClass)

Set the value of the outerStyleClass property.


setRole

public void setRole(java.lang.String role)

Set the value of the role property.


setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.


setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.


setTabindex

public void setTabindex(java.lang.String tabindex)

Set the value of the tabindex property.


setTitle

public void setTitle(java.lang.String title)

Set the value of the title property.