Controls Documentation

Controls  Complex Types  Show Hierarchies  Show Full Hierarchies 

Control: xe:com.ibm.xsp.dojo.form.FormWidget

f:javax.faces.Component
   f:javax.faces.Output
      f:javax.faces.Input
         xp:com.ibm.xsp.UIInputEx
            xe:com.ibm.xsp.dojo.form.FormWidget
               xe:djHorizontalSlider
               xe:djVerticalSlider
               xe:djButton
                  xe:djRadioButton
                  xe:djToggleButton
                     xe:djCheckBox
               xe:djextListTextBox
                  xe:djextNameTextBox
               xe:djTextBox
                  xe:djTextarea
                     xe:djSimpleTextarea
                  xe:djValidationTextBox
                     xe:djCurrencyTextBox
                     xe:djDateTextBox
                     xe:djNumberTextBox
                        xe:djNumberSpinner
                     xe:djTimeTextBox
                     xe:djComboBox
                        xe:djFilteringSelect

Description

Base Dojo form widget

Properties

Java

Java Class: com.ibm.xsp.extlib.component.dojo.form.UIDojoFormWidget


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
required, boolean  [Inherited]
Required Flag
Indicates that users must input a value for the control.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
immediate, boolean  [Inherited]
Immediate Action
Indicates that the value of the control must be converted and validated immediately during the Apply Request Values phase, not the Process Validation phase.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
multipleSeparator, string  [Inherited]
Multiple Values Separator
Indicates that this control is bound to multiple values and provides the delimiter used to separate them
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
multipleTrim, boolean  [Inherited]
Multiple Trim
Remove leading and trailing white space from individual values in a multiple value edit box. Defaults to removing the white space. Only applies when a Multiple Values Separator is set.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

data

value, generic  [Inherited]
Value
Contains the current value of the control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
converter, f:converterInterface - javax.faces.convert.Converter  [Inherited]
Converter
Converter instance registered with this control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
validator,   [Inherited]
Validator
MethodBinding representing a validator method that will be called during Process Validations to perform correctness checks on the value of this control. The expression must evaluate to a public method that takes FacesContext, UIComponent, and Object parameters, with a return type of void.
Required Attribute false
validators, Collection of f:validatorInterface - javax.faces.validator.Validator  [Inherited]
Validators List
An array of Validators associated with this control
Required Attribute false
valueChangeListener,   [Inherited]
Value Change Listener
MethodBinding representing a value change listener method that will be notified when a new value has been set for this input control. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void.
Required Attribute false
valueChangeListeners, Collection of xp:valueChangeListenerInterface - javax.faces.event.ValueChangeListener  [Inherited]
Value Change Listeners
A collection of value change listeners that will be notified when a new value has been set for this input control
Required Attribute false
disableModifiedFlag, boolean  [Inherited]
Disable Modified Flag
Disables this control from participating in modified notifications for the current XPage.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
disableValidators, boolean  [Inherited]
Disable Validators Flag
Disables the validators assigned to this control.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
showReadonlyAsDisabled, boolean  [Inherited]
Show Read Only As Disabled
Prevents a read only control appearing as text, and displays the actual control but in a read-only mode.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
disableClientSideValidation, boolean  [Inherited]
Disable client side validation
Disables the client side validation processes for this control.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
defaultValue, generic  [Inherited]
Default value
The default value of this 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

dojo-widget

dir, string
Direction
Unsupported by Dijit, but here for completeness. Dijit only supports setting text direction on the entire document. Bi-directional support, as defined by the [HTML DIR](http://www.w3.org/TR/html401/struct/dirlang.html#adef-dir) attribute. Either left-to-right "ltr" or right-to-left "rtl".
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
dragRestriction, boolean
Drag Restriction
To remove the drag capability
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
group, string
Group
Defines a group belonging.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
lang, string
Lang
Rarely used. Overrides the default Dojo locale used to render this widget, as defined by the [HTML LANG](http://www.w3.org/TR/html401/struct/dirlang.html#adef-lang) attribute. Value must be among the list of locales specified during by the Dojo bootstrap, formatted according to [RFC 3066](http://www.ietf.org/rfc/rfc3066.txt) (like en-us).
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
waiRole, string
ARIA Role
ARIA Role
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
waiState, string
ARIA State
ARIA State
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
alt, string
Alt
Alternate text that should appear should the browser not be able to display—a somewhat uncommon event for forms, although still common enough for images; works just like its pure-HTML equivalent.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
type, string
Type
Specifies the type of the element when more than one kind is possible. For example, a button might have type="submit" to trigger the form’s onsubmit action; works just like its pure-HTML equivalent. By default, this attribute is "text".
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
tabIndex, int
Tab Index
Used to provide an explicit tab index for keyboard navigation; works just like its HTML equivalent. By default, this attribute is "0".
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
disabled, boolean
Disabled
Disables a control so that it cannot receive focus and is skipped in tabbing navigation; do not attempt to use this attribute on an element that does not support it, which per the HTML 4.01 spec include button, input, optgroup, option, select, and textarea. Controls that are disabled are not included in form submissions. This attribute is false by default.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
readOnly, boolean
Read Only
Disables a control so that its value cannot be changed; however, it can still receive focus, is included in tabbing navigation, and is included in form submissions. Do not attempt to use this attribute on an element that does not support it, which per the HTML 4.01 spec include input and textarea. This attribute is false by default.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
intermediateChanges, boolean
Intermediate Changes
Whether to fire the onChange extension point for each value change. This attribute is false by default.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

events

onBlur, string
On Blur
Called when the widget stops being "active" because focus moved to something outside of it, or the user clicked somewhere outside of it, or the widget was hidden.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onClick, string
On Click
Connect to this function to receive notifications of mouse click events
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onClose, string
On Close
Callback if someone tries to close the child, child will be closed if func returns true
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onDblClick, string
On Double Click
Connect to this function to receive notifications of mouse double click events
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onFocus, string
On Focus
Called when the widget becomes "active" because it or a widget inside of it either has focus, or has recently been clicked.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onKeyDown, string
On Key Down
Connect to this function to receive notifications of keys being pressed down
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onKeyPress, string
On Key Press
Connect to this function to receive notifications of printable keys being typed.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onKeyUp, string
On Key Up
Connect to this function to receive notifications of keys being released
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onMouseDown, string
On Mouse Down
Connect to this function to receive notifications of when the mouse button is pressed down
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onMouseEnter, string
On Mouse Enter
Connect to this function to receive notifications of when the mouse moves onto this widget
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onMouseLeave, string
on Mouse Leave
Connect to this function to receive notifications of when the mouse moves off of this widget
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onMouseMove, string
On Mouse Move
Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onMouseOut, string
On Mouse Out
Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onMouseOver, string
On Mouse Over
Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onMouseUp, string
On Mouse Uo
Connect to this function to receive notifications of when the mouse button is released
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
forWaiValuenow, string
ForWaiValuenow
By default, returns the current state of the widget to be used for the WAI-ARIA valuenow state, which may be set via dijit. removeState and dijit.setWaiState.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onChange, string
On Change
Event called when the value of the widget changed
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
Style
HTML style attributes as cssText string or name/value hash
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
styleClass, string
Style Class
HTML class attribute
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true