Controls Documentation

Controls  Complex Types  Show Hierarchies  Show Full Hierarchies 

Control: xp:com.ibm.xsp.UICommandEx2

f:javax.faces.Component
   f:javax.faces.Command
      xp:com.ibm.xsp.UICommandEx2
         xp:button
         xp:eventHandler

Properties

Java

Java Class: com.ibm.xsp.component.UICommandEx2


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

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

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