Controls Documentation

Controls  Complex Types  Show Hierarchies  Show Full Hierarchies 

Control: xp:button

Description

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.

Properties

• <xp:button
• accessibility
• accesskey
• iconAlt
• role
• tabindex
• title
• basics
• binding
• dir
• disabled
• disableValidators
• dojoUsage
• execId
• execMode
• icon
• id
• lang
• loaded
• navigate
• refreshId
• refreshMode
• rendered
• rendererType
• save
• type
• value
• dojo
• dojoAttributes
• dojoType
• events
• action
• actionListener
• actionListeners
• immediate
• onblur
• onclick
• ondblclick
• onfocus
• onkeydown
• onkeypress
• onkeyup
• onmousedown
• onmousemove
• onmouseout
• onmouseover
• onmouseup
• styling
• disableTheme
• iconStyleClass
• outerStyleClass
• style
• styleClass
• themeId
• />

Java

Java Class: com.ibm.xsp.component.xp.XspCommandButton

accessibility

title, string Advisory Title Provides title information for controls. Required Attribute false Localizable true Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

tabindex, string Tab Index 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. Required Attribute false Localizable false Allow Runtime Binding false Allow Load Time Binding true Allow Non Binding true

accesskey, string Access Key Transfers focus to the control when pressed Required Attribute false Localizable true Allow Runtime Binding false Allow Load Time Binding true Allow Non Binding true

role, string Control Identifier Describes the role of the current UI element/area. It can be used by assistive technologies to determine its purpose. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

iconAlt, string Icon Alternate Text Descriptive text for an icon on the button control. Required Attribute false Localizable true Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

basics

binding, object - javax.faces.component.UIComponent  [Inherited] Control Binding Specifies an expression that binds the control to a particular control property. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding false

loaded, boolean  [Inherited] Loaded Specifies whether or not the control should be created when the page is loaded. Value defaults to 'true'. Required Attribute false Localizable false Allow Runtime Binding false Allow Load Time Binding true Allow Non Binding true

id, string  [Inherited] Control Identifier Specifies the name identifier for the control. No two controls can have the same name identifier in a single page. Required Attribute false Localizable false Allow Runtime Binding false Allow Load Time Binding true Allow Non Binding true

rendered, boolean  [Inherited] Rendered Flag Indicates whether or not the control should be displayed or processed on any subsequent form submission. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

rendererType, string  [Inherited] Renderer Type Identifies (with the "family" defined by the control) an appropriate renderer to encode and decode this control Required Attribute false Localizable false Allow Runtime Binding false Allow Load Time Binding true Allow Non Binding true

value, generic  [Inherited] Value Specifies the value of the control. Value is typically rendered as a label. Required Attribute false Localizable true Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

save, boolean  [Inherited] Save Specifies if a save should occur after the action associated with the command. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

navigate, boolean  [Inherited] Navigate Indicates whether the result of the action should be used to navigate to another page. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

disableValidators, boolean  [Inherited] Disable validators Indicates if the validators should be disabled when the action is executed. This is different from immediate property in a sense that the full JSF life cycle is processed, but simply the validators are not executed. This allows 'save as draft' kind of behaviors. Note that the converters are still executed and can generate validation errors. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

execMode, string  [Inherited] Execution Mode Relevant to performance optimization. This can be a complete execution (default) or a partial execution. With partial execution, XPages goes through the execution phases of the page lifecycle for this control only (and its children, if any). Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

execId, string  [Inherited] Fragment to execute When execution mode is set to partial, the execId can be used to specify an alternative control or container area for which to execute the page lifecycle. This execution Id will default to the current Event Handler control. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

refreshId, string  [Inherited] Fragment to Refresh Specify the ID of the markup fragment to refresh. If the ID is empty, then the parent of the event handler gets refreshed. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

refreshMode, string  [Inherited] Refresh Mode Indicates the refresh mode, which can be a complete submission and page refresh (default), a partial refresh, or no refresh. Valid values are 'complete', 'partial', or 'norefresh'. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

type, string  [Inherited] Type Specifies the function of the button Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

dir, string Direction Specifies the direction for text that does not inherit a direction. Valid values are 'LTR' (left to right) and 'RTL' (right to left). Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

lang, string Language Code Describes the language used in the generated markup of the control. Required Attribute false Localizable true Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

disabled, boolean Disabled Flag Determines whether or not the page can receive focus or be included in page submissions. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

dojoUsage, string Dojo Usage This property is obsolete, configure the "Dojo Type" property instead. This used to determine whether the control would use Dojo. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

icon, string Icon URL The path to an icon displayed at the start of the button control. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

dojo

dojoType, string  [Inherited] Dojo Type Sets the default Dojo Type used to create this control in the browser. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

dojoAttributes, Collection of xp:dojoAttribute - com.ibm.xsp.dojo.DojoAttribute  [Inherited] Dojo Attributes Specifies a list of Dojo attributes. Required Attribute false

events

action,   [Inherited] Application Action MethodBinding representing the application action to invoke when this control is activated by the user. The expression must evaluate to a public method that takes no parameters, and returns a String (the logical outcome) that is passed to the NavigationHandler for this application. Required Attribute false

actionListener,   [Inherited] Action Listener MethodBinding representing an action listener method that will be notified when this control is activated by the user. The expression must evaluate to a public method that takes an ActionEvent parameter with a return type of void. Required Attribute false

actionListeners, Collection of xp:actionListenerInterface - javax.faces.event.ActionListener  [Inherited] Action Listener List A collection of Action listeners attached to this control Required Attribute false

immediate, boolean  [Inherited] Immediate Action Flag indicating that if this control is activated by the user, notifications should be delivered to interested listeners and actions immediately (during Apply Request Values phase) rather than waiting until Invoke Application phase. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onclick, string Click Script JavaScript code executed when a pointer control is clicked over this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

ondblclick, string Double Click Script JavaScript code executed when a pointer control is double clicked over this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onmousedown, string Mouse Down Script JavaScript code executed when a pointer control is pressed down over this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onmouseup, string Mouse Up Script JavaScript code executed when a pointer control is released over this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onmouseover, string Mouse Over Script JavaScript code executed when a pointer control is moved onto this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onmousemove, string Mouse Move Script JavaScript code executed when a pointer control is moved within this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onmouseout, string Mouse Out Script JavaScript code executed when a pointer control is moved away from this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onkeypress, string Key Press Script JavaScript code executed when a key is pressed and released over this control. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onkeydown, string Key Down Script JavaScript code executed when a key is pressed down over this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onkeyup, string Key Up Script JavaScript code executed when a key is released over this control Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onblur, string Focus Off Script JavaScript code executed when this control loses focus Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

onfocus, string Focus On Script JavaScript code executed when this control receives focus Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

styling

disableTheme, boolean  [Inherited] Disable Theme A flag used to determine if the theme should be applied to this control. Required Attribute false Localizable false Allow Runtime Binding false Allow Load Time Binding true Allow Non Binding true

themeId, string  [Inherited] Theme Id The theme id that should be used to set the component properties when a theme is applied Required Attribute false Localizable false Allow Runtime Binding false Allow Load Time Binding true Allow Non Binding true

style, string CSS Styles Specifies CSS style(s) to be applied when this control is rendered. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

styleClass, string CSS Style Classes 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. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

outerStyleClass, string CSS Outer Style Classes 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. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

iconStyleClass, string Obsolete Icon Style Class This property is obsolete and ignored. Use the "Dojo Attributes" property instead, adding an attribute with name "iconClass" Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true