Controls Documentation

Controls  Complex Types  Show Hierarchies  Show Full Hierarchies 

Control: xp:com.ibm.xsp.UIInputText

Properties

• basics
• binding
• id
• immediate
• loaded
• multipleSeparator
• multipleTrim
• password
• redisplay
• rendered
• rendererType
• required
• data
• converter
• defaultValue
• disableClientSideValidation
• disableModifiedFlag
• disableValidators
• showReadonlyAsDisabled
• validator
• validators
• value
• valueChangeListener
• valueChangeListeners
• dojo
• dojoAttributes
• dojoType
• styling
• disableTheme
• themeId

Java

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

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

redisplay, boolean Redisplay Flag Flag indicating that any existing value in this field should be rendered when the form is created. Because this is a potential security risk, password values are not displayed by default. Required Attribute false Localizable false Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

password, boolean Password Indicates whether or not users are entering a password. If true, the characters are masked in the field, for example as asterisks. Required Attribute false Localizable false Allow Runtime Binding false Allow Load Time Binding true Allow Non Binding true

data

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

value, generic Value Contains the current value of the control Required Attribute false Localizable true Allow Runtime Binding true Allow Load Time Binding true Allow Non Binding true

defaultValue, generic Default value The default value of this control Required Attribute false Localizable true 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

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