Attributes |
Name | Required | Request-time | Type | Description |
accesskey | no | false | java.lang.String | Access key that, when pressed, transfers focus to this element. |
alt | no | false | java.lang.String | Alternate textual description of the element rendered by this component. |
autocomplete | no | false | java.lang.String | If the value of this attribute is "off", render "off" as the value of the attribute. This indicates that the browser should disable its autocomplete feature for this component. This is useful for components that perform autocompletion and do not want the browser interfering. If this attribute is not set or the value is "on", render nothing. |
binding | no | false | javax.el.ValueExpression | Using an EL expression, bind the component reference to a bean property, so that the component may be accessed in the bean. |
caseSensitive | no | false | boolean | Boolean value that indicates whether the filtering should be case sensitive or not. Default = 'false'. |
clientSide | no | false | boolean | Boolean value that indicates whether the autocomplete functionality should be done on the client or on the server. Client-side mode can be faster, as no round trips to the server need to be made. However, if the list of possible results is too large, the browser might become slower, since the entire list has to be stored in the client as HTML nodes. It is recommended not to use lists of more than 1000 items when using the client-side mode. Default = 'false'. |
converter | no | false | javax.faces.convert.Converter | Converter is an interface describing a Java class that can perform Object-to-String and String-to-Object conversions between model data objects and a String representation of those objects that is suitable for rendering. |
converterMessage | no | false | java.lang.String | If present, will be used as the text of the converter message, replacing any message that comes from the converter. |
delay | no | false | int | Delay in milliseconds for showing the list of possible matches after typing a character. Default = '400'. |
dir | no | 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). |
direction | no | false | java.lang.String | Direction in which to show the list of possible matches. Possible values are "up", "down", and "auto". |
disabled | no | false | boolean | Flag indicating that this element must never receive focus or be included in a subsequent submit. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as disabled="disabled". Default = 'false'. |
filterBy | no | false | java.lang.Object | ValueExpression that specifies the property of the data object to use for filtering values. This only applies when listvar is used and the rendering is done by means of a facet. |
filterMatchMode | no | false | java.lang.String | Defines the method of filter comparison used, default is "startsWith". Types available include: "contains", "exact", "startsWith", "endsWith" and "none". Typically, "none" will be used in cases where more complex, custom filtering is needed or when option values need to be loaded lazily (e.g. from a data base). Default = 'startsWith'. |
height | no | false | int | Maximum height in pixels of the list of possible matches (if 0, then the size is automatically adjusted to show all possible matches). |
hideEffect | no | false | java.lang.String | Effect to use when hiding the list. Possible values are 'blind', 'bounce', 'clip', 'drop', 'explode', 'fade', 'fold', 'puff', 'pulsate', 'scale', and 'slide'. Default = 'fade'. |
hideEffectLength | no | false | int | Length of time in milliseconds the hide effect will last for. Default = '150'. |
id | no | 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 | no | false | boolean | A flag indicating that conversion and validation of this component's value should occur during Apply Request Values phase instead of Process Validations phase. Default = 'false'. |
indicatorPosition | no | false | java.lang.String | Position of input-required or input-optional indicator relative to input field or label. Supported values are "left/right/top/bottom/labelLeft/labelRight/none". Default is "labelRight" if labelPosition is "inField", "right" otherwise. |
label | no | false | java.lang.String | A localized user presentable name for this component. |
labelPosition | no | false | java.lang.String | Position of label relative to input field. Supported values are "left/right/top/bottom/inField/none". Default is "none". |
lang | no | false | java.lang.String | Code describing the language used in the generated markup for this component. |
listValue | no | false | java.util.List | When rendering via a facet, this attribute specifies the list of data objects that contains all possible options. |
listVar | no | false | java.lang.String | Variable name to use for referencing each data object in the list when rendering via a facet. |
maxlength | no | false | int | The maximum number of characters that may be entered in this field. |
minChars | no | false | int | Minimum number of characters that must be in the text field before submitting and before producing the list of possible matches. Default = '0'. |
onblur | no | false | java.lang.String | Javascript code executed when this element loses focus. |
onchange | no | false | java.lang.String | Javascript code executed when this element loses focus and its value has been modified since gaining focus. |
onclick | no | false | java.lang.String | Javascript code executed when a pointer button is clicked over this element. |
ondblclick | no | false | java.lang.String | Javascript code executed when a pointer button is double clicked over this element. |
onfocus | no | false | java.lang.String | Javascript code executed when this element receives focus. |
onkeydown | no | false | java.lang.String | Javascript code executed when a key is pressed down over this element. |
onkeypress | no | false | java.lang.String | Javascript code executed when a key is pressed and released over this element. |
onkeyup | no | false | java.lang.String | Javascript code executed when a key is released over this element. |
onmousedown | no | false | java.lang.String | Javascript code executed when a pointer button is pressed down over this element. |
onmousemove | no | false | java.lang.String | Javascript code executed when a pointer button is moved within this element. |
onmouseout | no | false | java.lang.String | Javascript code executed when a pointer button is moved away from this element. |
onmouseover | no | false | java.lang.String | Javascript code executed when a pointer button is moved onto this element. |
onmouseup | no | false | java.lang.String | Javascript code executed when a pointer button is released over this element. |
onselect | no | false | java.lang.String | Javascript code executed when text within this element is selected by the user. |
optionalIndicator | no | false | java.lang.String | Indicator indicating that the user is NOT required to provide a submitted value for this input component. |
readonly | no | false | boolean | Flag indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as readonly="readonly". Default = 'false'. |
rendered | no | false | boolean | Return true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. Default = 'true'. |
required | no | false | boolean | A flag indicating whether the user required to provide a non-empty submitted value for this component. Default = 'false'. |
requiredIndicator | no | false | java.lang.String | Indicator indicating that the user is required to provide a submitted value for this input component. |
requiredMessage | no | false | java.lang.String | If present, will be used as the text of the validation message for the "required" facility, if the "required" facility is used. |
rows | no | false | int | The maximum number of possible options to show to the user. Default = '10'. |
showEffect | no | false | java.lang.String | Effect to use when showing the list. Possible values are 'blind', 'bounce', 'clip', 'drop', 'explode', 'fade', 'fold', 'puff', 'pulsate', 'scale', 'slide', and 'shake'. Default = 'fade'. |
showEffectLength | no | false | int | Length of time in milliseconds the show effect will last for. Default = '150'. |
size | no | false | int | The number of characters used to determine the width of this field. |
style | no | false | java.lang.String | CSS style(s) to be applied when this component is rendered. |
styleClass | no | false | java.lang.String | Style class name of the container element. |
tabindex | no | 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 | no | false | javax.el.MethodExpression | MethodExpression representing a text change listener method that will be notified when the text of the input field changes after the user types new characters or removes them. This is different from a value change event in that in this case the user has not yet given a definite input and is just typing strings to to obtain lists of possible values. The value change event differs in that it only fires once the user has selected a value from the list or has pressed 'enter' on the input field. The expression must evaluate to a public method that takes a org.icefaces.ace.event.TextChageEvent parameter, with a return type of void. |
title | no | false | java.lang.String | Advisory title information about markup elements generated for this component. |
validator | no | false | javax.el.MethodExpression | MethodExpression 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 | no | false | java.lang.String | If present, will be used as the text of the validator message, replacing any message that comes from the validator. |
value | no | false | java.lang.Object | The current value of the simple component. The value to be rendered. |
valueChangeListener | no | false | javax.el.MethodExpression | MethodExpression 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, or to a public method that takes no arguments with a return type of void. In the latter case, the method has no way of easily knowing what the new value is, but this can be useful in cases where a notification is needed that "this value changed". |
width | no | false | int | The width of the text input field, in pixels. Default = '150'. |