Input Assist Behavior

Input Assist Behavior

Enables input assist and/or input validation on an inputText field. With input assist enabled, when the field gets focus, prompt characters are displayed in the field indicating where a user may type. As the user types, the cursor is managed so it is always positioned where a user may type. If a user enters an invalid character for that position, the character is ignored. Auto-advance and IME management may also be enabled. When input validation is enabled, when the field gets focus or loses focus, the content of the field is validated for correctness using one or more validation rules. If the field is invalid, actions may be taken such as changing the display of the field, displaying an error message, or moving focus/selection.

Rendering

The component's visual rendering varies depending upon the component selected.

Quick Edit view

Configure this component using the Quick Edit view. To open the Quick Edit view, click

Window | Show View | Quick Edit.

The common attributes for the <hx:inputHelperAssist> component are listed in the table below.

Table 1. Input Assist Behavior attributes

Attribute name

Description

autoSubmit

If autoTab is true, then if autoSubmit is true, then when a user types in sufficient characters to auto-advance to the next field, instead of advancing, the form containing the field is submitted. This attribute is primarily intended for use by applications trying to emulate certain "antique" input mechanisms such as emulating 3270 terminals.

autoTab

If false or omitted, focus does not advance to the next field when the maximum number of characters is entered. If true, when the maximum number of characters for the field are entered, focus advances to the next field. For autoadvance to work correctly, either the field should have a pattern that unambiguously identifies the maximum number of characters in the field or maxlength should be set on the field. For example, the pattern ##9 is ambiguous. Three characters can be entered for a positive number while four characters can be entered for a negative number. So maxlength should be set in this case.

binding

An expression that binds the component's instance (usually a user interface component) to a bean property (usually in the backing file).

errorAction

If validation is set to true, the name of the action(s) to be run if the field's value fails validation when onblur is fired. If more than one action name is provided they should be separated with a semicolon.

id

Assigns a name to a component. Should be a unique name within a JSP.

imeMode

If supplied, when the field gets focus, the CSS imeMode property is set to the value supplied. This property only works with browsers that support the CSS imeMode property (currently only Internet Explorer supports this).

inputAssist

Currently not available. When the feature is enabled, inputAssist will turn on character checking (veryify that a valid character is entered).

onerror

If provided, a JavaScript™ function to be executed when onblur fires and the field value fails validation. The function is executed before the action is executed. If the function returns false, the action is not run and processing of the event is halted (if the DOM halts it).

onfocuserror

If provided, a JavaScript function to be executed when onfocus fires and the field value fails conversion. The function is executed before the action is executed. If the function returns false, the action is not run and processing of the event is halted (if the DOM halts it).

onfocussuccess

If provided, a JavaScript function to be executed when onfocus fires and the field value passes conversion. The function is executed before the action is executed. If the function returns false, the action is not run and the error case is processed.

onfocusErrorAction

If validation is set to true, the name of the action(s) to be run if the field value fails conversion when onfocus is fired. If more than one action name is provided they should be separated with a semicolon.

onfocusSuccessAction

If validation is set to true, the name of the action(s) to be run if the field's value passes conversion when onfocus is fired. If more than one action name is provided they should be separated with a semicolon.

onfocusSuccessClass

If validation is set to true, the name of the CSS class that is to be applied to the field if the field's value passes conversion when onfocus is fired.

onsuccess

If provided, a JavaScript function to be executed when onblur fires and the field value passes validation. The function is executed before the action is executed. If the function returns false, the action is not run and the error case is processed.

promptCharacter

If provided, the field is put in assist mode where each character position in the field is shown with the specified prompt character or the current value of the field. For date/time fields, the date is represented using all numeric characters. Only valid characters may be entered in each position. As the user types the cursor is automatically advanced to an appropriate position.

rendered

Can be set to true or false:

false - Component will not be rendered to the browser at runtime.

true - Component will get rendered. This is the default value.

successAction

If validation is set to true, the name of the action(s) to be run if the field value passes validation when onblur is fired. If more than one action name is provided they should be separated with a semicolon.

successClass

If validation is set to true, the name of the CSS class that is to be applied to the field if the field value passes validation when onblur is fired.

targetErrorAction

The target(s) of the action(s) associated with the errorAction parameter. By default, the target is the tag the behavior is assigned to (via target). If more than one action is provided, more than one target may be provided (separated by semicolons)

targetOnFocusErrorAction

The target(s) of the action(s) associated with the onFocusErrorAction parameter. By default, the target is the tag the behavior is assigned to (via target). If more than one action is provided, more than one target may be provided (separated by semicolons).

targetOnfocusSuccessAction

The target(s) of the action(s) associated with the onFocusSucessAction parameter. By default, the target is the tag the behavior is assigned to (via target). If more than one action is provided, more than one target may be provided (separated by semicolons).

targetSuccessAction

The target(s) of the action(s) associated with the successAction parameter. By default, the target is the tag the behavior is assigned to (via target). If more than one action is provided, more than one target may be provided (separated by semicolons).

validation

Specifies whether client-side validation is enabled or not. The default value is true (enabled).

Attribute name	Description
autoSubmit	If autoTab is true, then if autoSubmit is true, then when a user types in sufficient characters to auto-advance to the next field, instead of advancing, the form containing the field is submitted. This attribute is primarily intended for use by applications trying to emulate certain "antique" input mechanisms such as emulating 3270 terminals.
autoTab	If false or omitted, focus does not advance to the next field when the maximum number of characters is entered. If true, when the maximum number of characters for the field are entered, focus advances to the next field. For autoadvance to work correctly, either the field should have a pattern that unambiguously identifies the maximum number of characters in the field or maxlength should be set on the field. For example, the pattern ##9 is ambiguous. Three characters can be entered for a positive number while four characters can be entered for a negative number. So maxlength should be set in this case.
binding	An expression that binds the component's instance (usually a user interface component) to a bean property (usually in the backing file).
errorAction	If validation is set to true, the name of the action(s) to be run if the field's value fails validation when onblur is fired. If more than one action name is provided they should be separated with a semicolon.
id	Assigns a name to a component. Should be a unique name within a JSP.
imeMode	If supplied, when the field gets focus, the CSS imeMode property is set to the value supplied. This property only works with browsers that support the CSS imeMode property (currently only Internet Explorer supports this).
inputAssist	Currently not available. When the feature is enabled, inputAssist will turn on character checking (veryify that a valid character is entered).
onerror	If provided, a JavaScript™ function to be executed when onblur fires and the field value fails validation. The function is executed before the action is executed. If the function returns false, the action is not run and processing of the event is halted (if the DOM halts it).
onfocuserror	If provided, a JavaScript function to be executed when onfocus fires and the field value fails conversion. The function is executed before the action is executed. If the function returns false, the action is not run and processing of the event is halted (if the DOM halts it).
onfocussuccess	If provided, a JavaScript function to be executed when onfocus fires and the field value passes conversion. The function is executed before the action is executed. If the function returns false, the action is not run and the error case is processed.
onfocusErrorAction	If validation is set to true, the name of the action(s) to be run if the field value fails conversion when onfocus is fired. If more than one action name is provided they should be separated with a semicolon.
onfocusSuccessAction	If validation is set to true, the name of the action(s) to be run if the field's value passes conversion when onfocus is fired. If more than one action name is provided they should be separated with a semicolon.
onfocusSuccessClass	If validation is set to true, the name of the CSS class that is to be applied to the field if the field's value passes conversion when onfocus is fired.
onsuccess	If provided, a JavaScript function to be executed when onblur fires and the field value passes validation. The function is executed before the action is executed. If the function returns false, the action is not run and the error case is processed.
promptCharacter	If provided, the field is put in assist mode where each character position in the field is shown with the specified prompt character or the current value of the field. For date/time fields, the date is represented using all numeric characters. Only valid characters may be entered in each position. As the user types the cursor is automatically advanced to an appropriate position.
rendered	Can be set to true or false: false - Component will not be rendered to the browser at runtime. true - Component will get rendered. This is the default value.
successAction	If validation is set to true, the name of the action(s) to be run if the field value passes validation when onblur is fired. If more than one action name is provided they should be separated with a semicolon.
successClass	If validation is set to true, the name of the CSS class that is to be applied to the field if the field value passes validation when onblur is fired.
targetErrorAction	The target(s) of the action(s) associated with the errorAction parameter. By default, the target is the tag the behavior is assigned to (via target). If more than one action is provided, more than one target may be provided (separated by semicolons)
targetOnFocusErrorAction	The target(s) of the action(s) associated with the onFocusErrorAction parameter. By default, the target is the tag the behavior is assigned to (via target). If more than one action is provided, more than one target may be provided (separated by semicolons).
targetOnfocusSuccessAction	The target(s) of the action(s) associated with the onFocusSucessAction parameter. By default, the target is the tag the behavior is assigned to (via target). If more than one action is provided, more than one target may be provided (separated by semicolons).
targetSuccessAction	The target(s) of the action(s) associated with the successAction parameter. By default, the target is the tag the behavior is assigned to (via target). If more than one action is provided, more than one target may be provided (separated by semicolons).
validation	Specifies whether client-side validation is enabled or not. The default value is true (enabled).