| |||||||
FRAMES NO FRAMES |
The selectInputText component provides an inputText component enhanced with auto-complete functionality. As the user enters text into the component it provides a popup list of possible matching values that the user may select from. The component predicts a word or phrase that a user wants to type in without the user actually completely typing it in. The selectInputText component requires developers to implement the matching list search algorithm in their backing bean.
The selectInputText component can generate one of two types of lists:
1. A list of String data.
2. A list of arbitrarily complex child components.
The server call delay frequency can be configured using the "options" attribute. Please see the description of "options" attribute for detail.
Tag Information | |
Tag Class | com.icesoft.faces.component.selectinputtext.SelectInputTextTag |
TagExtraInfo Class | None |
Body Content | JSP |
Display Name | None |
Attributes | ||||
Name | Required | Request-time | Type | Description |
accesskey | false | false | java.lang.String | Access key that, when pressed, transfers focus to this element. |
action | false | false | java.lang.String | MethodBinding representing the application action to invoke when this component is activated by the user. The expression must evaluate to a either a String or a public method that takes no parameters, and returns a String (the logical outcome) which is passed to the NavigationHandler for this application. |
actionListener | false | false | java.lang.String | MethodBinding representing an action listener method that will be notified when this component is activated by the user. The expression must evaluate to a public method that takes an ActionEvent parameter, with a return type of void. |
alt | false | false | java.lang.String | Alternate textual description of the element rendered by this component. |
autocomplete | false | false | java.lang.String | Passed through to root element. |
binding | false | false | java.lang.String | The value binding expression linking this component to a property in a backing bean |
converter | false | false | java.lang.String | Converter instance registered with this component. |
converterMessage | false | false | java.lang.String | A ValueExpression enabled attribute that, if present, will be used as the text of the converter message, replacing any message that comes from the converter. |
dir | false | false | java.lang.String | Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). |
disabled | false | false | java.lang.String | Flag indicating that this element must never receive focus or be included in a subsequent submit. |
effect | false | false | java.lang.String | The Javascript Effect |
enabledOnUserRole | false | false | java.lang.String | If user is in given role, this component will be rendered normally. If not, the component will be in disabled state. |
id | false | false | java.lang.String | The component identifier for this component. This value must be unique within the closest parent component that is a naming container. |
immediate | false | false | java.lang.String | Flag indicating that this component's value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until Process Validations phase. |
label | false | false | java.lang.String | A localized user presentable name for this component. |
lang | false | false | java.lang.String | Code describing the language used in the generated markup for this component. |
listValue | false | false | java.lang.String | The list of selectItem components. |
listVar | false | false | java.lang.String | Name of a request-scope attribute under which the model data for the row selected by the current value of the "rowIndex" property (i.e. also the current value of the "rowData" property) will be exposed. |
maxlength | false | false | java.lang.String | The maximum number of characters that may be entered in this field. |
onblur | false | false | java.lang.String | Javascript code executed when this element loses focus. |
onchange | false | false | java.lang.String | Javascript code executed when this element loses focus and its value has been modified since gaining focus. |
onclick | false | false | java.lang.String | No Description |
onclickeffect | false | false | java.lang.String | Effect invoked on onclick event |
ondblclick | false | false | java.lang.String | No Description |
ondblclickeffect | false | false | java.lang.String | Effect invoked on ondblclick event |
onfocus | false | false | java.lang.String | Javascript code executed when this element receives focus. |
onkeydown | false | false | java.lang.String | No Description |
onkeydowneffect | false | false | java.lang.String | Effect invoked on onkeydown event |
onkeypress | false | false | java.lang.String | No Description |
onkeypresseffect | false | false | java.lang.String | Effect invoked on onkeypress event |
onkeyup | false | false | java.lang.String | No Description |
onkeyupeffect | false | false | java.lang.String | Effect invoked on onkeyup event |
onmousedown | false | false | java.lang.String | No Description |
onmousedowneffect | false | false | java.lang.String | Effect invoked on onmousedown event |
onmousemove | false | false | java.lang.String | No Description |
onmousemoveeffect | false | false | java.lang.String | Effect invoked on onmousemove event |
onmouseout | false | false | java.lang.String | No Description |
onmouseouteffect | false | false | java.lang.String | Effect invoked on onmouse event |
onmouseover | false | false | java.lang.String | No Description |
onmouseovereffect | false | false | java.lang.String | Effect invoked on onmouseover event |
onmouseup | false | false | java.lang.String | No Description |
onmouseupeffect | false | false | java.lang.String | Effect invoked on onmouseup event |
onselect | false | false | java.lang.String | Javascript code executed when text within this element is selected by the user. |
options | false | false | java.lang.String | The value of this attribute will be passed to the "options" param of the Autocompleter.js. Which allows to set different options to the autoCompleter object. For example the server call delay frequency can be changed to 100 Milliseconds (e.g.) |
partialSubmit | false | false | java.lang.String | Enable component to perform partial submit. Default value is false. |
readonly | false | false | java.lang.String | Flag indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled. This attribute is valid for input types "text" and "password" only. It is non-functional for other input types like "radio" or "checkbox". |
rendered | false | false | java.lang.String | Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. |
renderedOnUserRole | false | false | java.lang.String | If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped. |
required | false | false | java.lang.String | Flag indicating that the user is required to provide a submitted value for this input component. |
requiredMessage | false | false | java.lang.String | A ValueExpression enabled attribute that, if present, will be used as the text of the validation message for the "required" facility, if the "required" facility is used. |
rows | false | false | java.lang.String | The number of rows to display, starting with the one identified by the "first" property. If this value is set to zero, all available rows in the underlying data model will be displayed. |
size | false | false | java.lang.String | The number of characters used to determine the width of this field. |
style | false | false | java.lang.String | CSS style(s) to be applied when this component is rendered. |
styleClass | false | false | java.lang.String | Base name for the style classes. Deafult is iceSelInpTxt. if enabled
|
tabindex | false | false | java.lang.String | Position of this element in the tabbing order for the current document. This value must be an integer between 0 and 32767. |
textChangeListener | false | false | java.lang.String | MethodBinding behaving similarly to valueChangeListener. The target bean method will receive an argument of type com.icesoft.faces.component.selectinputtext.TextChangeEvent, which is a subclass of ValueChangeEvent. The new value in the event is the submittedValue of the SelectInputText component. The purpose of textChangeListener is to notify when the user has manually typed in text into the SelectInputText component, as opposed to selecting a list entry. This way, the application can refine the selection list, from the entered text. The MethodBinding is invoked in the APPLY_REQUEST_VALUES phase, much like RowSelector's selectionListener, allowing for the bean method to call FacesContext.getCurrentInstance().renderResponse(), and keep validation from happenning, on partially inputted text which would be known to fail validation. |
title | false | false | java.lang.String | Advisory title information about markup elements generated for this component. |
validator | false | false | java.lang.String | MethodBinding representing a validator method that will be called during Process Validations to perform correctness checks on the value of this component. The expression must evaluate to a public method that takes FacesContext, UIComponent, and Object parameters, with a return type of void. |
validatorMessage | false | false | java.lang.String | A ValueExpression enabled attribute that, if present, will be used as the text of the validator message, replacing any message that comes from the validator. |
value | false | false | java.lang.String | The current value of this component. All UIInput derived UIComponents, that are placed within a UIData container, such as a dataTable or panelSeries, should have their value attribute bound to a bean property via a ValueBinding/ValueExpression, since otherwise the UIData container will not keep their successfully validated state, which can cause the component to fail to function properly. |
valueChangeListener | false | false | java.lang.String | MethodBinding representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void. |
visible | false | false | java.lang.String | Set the visibility of this component. When false CSS style is set to display:none |
width | false | false | java.lang.String | Sets the width of both, inputText and associated drop down list. |
Variables | No Variables Defined. |
| |||||||
FRAMES NO FRAMES |