ICEfaces ACE Components
Tag autoCompleteEntry


AutoCompleteEntry is a text input component that presents possible valid options as the user types. The options can be a list of SelectItem's specified in a child tag. It is also possible to specify a list of arbitrary data objects (i.e. POJOs) through the listValue attribute. In this case, a facet named "row" should be nested inside this component. This allows for more flexible rendering of each row, making it possible to render other components or HTML for each row and to display different properties of the data object.

For more information, see the AutoCompleteEntry Wiki Documentation.


Client Events
NameDescriptionSupported Classes for ArgumentDefault Event Scopes
submitFired any time the value of the text input field is submitted to the server, either by typing a character, clicking on an option from the list, selecting an option with the keyboard, or pressing enter on the text field. If there are also textChange and/or valueChange events registered for this component, this event will not fire in those cases, since the other events are more specific and have precedence.javax.faces.event.AjaxBehaviorEventexecute=@this render=@all
blurFired any time the text input field loses focus.javax.faces.event.AjaxBehaviorEventexecute=@this render=@all
textChangeFired any time the user adds or removes characters from the text field by typing or by pasting text.javax.faces.event.AjaxBehaviorEventexecute=@this render=@all
valueChange(default event) Fired when the user gives a more definite input for this component either by clicking on an option from the list, or selecting an option with the keyboard, or pressing enter on the text field.javax.faces.event.AjaxBehaviorEventexecute=@this render=@all
Client events can be used with Client Behaviors and the ace:ajax tag.


Tag Information
Tag Classorg.icefaces.ace.component.autocompleteentry.AutoCompleteEntryTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
accesskeynotruejava.lang.StringAccess key that, when pressed, transfers focus to this element.
altnotruejava.lang.StringAlternate textual description of the element rendered by this component.
autocompletenotruejava.lang.StringIf 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.
bindingnotruejavax.el.ValueExpressionUsing an EL expression, bind the component reference to a bean property, so that the component may be accessed in the bean.
caseSensitivenotruebooleanBoolean value that indicates whether the filtering should be case sensitive or not. Default = 'false'.
clientSidenotruebooleanBoolean 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'.
converternotruejavax.faces.convert.ConverterConverter 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.
converterMessagenotruejava.lang.StringIf present, will be used as the text of the converter message, replacing any message that comes from the converter.
delaynotrueintDelay in milliseconds for showing the list of possible matches after typing a character. Default = '250'.
dirnotruejava.lang.StringDirection indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left).
directionnotruejava.lang.StringDirection in which to show the list of possible matches. Possible values are "up", "down", and "auto".
disablednotruebooleanFlag 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'.
filterBynotruejava.lang.ObjectValueExpression 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.
filterMatchModenotruejava.lang.StringDefines 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'.
heightnotrueintMaximum height in pixels of the list of possible matches (if 0, then the size is automatically adjusted to show all possible matches).
hideEffectnotruejava.lang.StringEffect to use when hiding the list. Possible values are 'blind', 'bounce', 'clip', 'drop', 'explode', 'fade', 'fold', 'puff', 'pulsate', 'scale', and 'slide'. Default = 'fade'.
hideEffectLengthnotrueintLength of time in milliseconds the hide effect will last for. Default = '150'.
idnotruejava.lang.StringThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.
immediatenotruebooleanA 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'.
indicatorPositionnotruejava.lang.StringPosition 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.
labelnotruejava.lang.StringA localized user presentable name for this component.
labelPositionnotruejava.lang.StringPosition of label relative to input field. Supported values are "left/right/top/bottom/inField/none". Default is "none".
langnotruejava.lang.StringCode describing the language used in the generated markup for this component.
listValuenotruejava.util.ListWhen rendering via a facet, this attribute specifies the list of data objects that contains all possible options.
listVarnotruejava.lang.StringVariable name to use for referencing each data object in the list when rendering via a facet.
maxlengthnotrueintThe maximum number of characters that may be entered in this field.
minCharsnotrueintMinimum number of characters that must be in the text field before submitting and before producing the list of possible matches. Default = '0'.
onblurnotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
onchangenotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
onclicknotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
ondblclicknotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
onfocusnotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
onkeydownnotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
onkeypressnotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
onkeyupnotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
onmousedownnotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
onmousemovenotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
onmouseoutnotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
onmouseovernotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
onmouseupnotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
onselectnotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
optionalIndicatornotruejava.lang.StringIndicator indicating that the user is NOT required to provide a submitted value for this input component.
placeholdernotruejava.lang.StringThe HTML5 placeholder attribute represents a short hint (a word or short phrase) intended to aid the user with data entry when the input element has no value. If the placeholder attribute is not supported by the browser, the label 'inField' functionality will be used instead. Alternatively, the Mojarra HTML5 'placeholder' passthrough attribute may also be used with this component.
readonlynotruebooleanFlag 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'.
renderednotruebooleanReturn true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. Default = 'true'.
requirednotruebooleanA flag indicating whether the user required to provide a non-empty submitted value for this component. Default = 'false'.
requiredIndicatornotruejava.lang.StringIndicator indicating that the user is required to provide a submitted value for this input component.
requiredMessagenotruejava.lang.StringIf present, will be used as the text of the validation message for the "required" facility, if the "required" facility is used.
resetnotruebooleanFlag to reset the component values completely. This component internally stores a number of temporary values to perform its functions. Since these values are not accessible to the app developer, they might linger after resetting the main value. Set this flag to true to completely reset all these temporary internal values. These values will be reset in the RENDER_RESPONSE phase. After that, this flag will automatically be set to false again. Typically this flag will be set in an action listener. When setting this flag to true, it is also advised to set the property bound to this component's value to null. Default = 'false'.
rowsnotrueintThe maximum number of possible options to show to the user. Default = '10'.
showEffectnotruejava.lang.StringEffect to use when showing the list. Possible values are 'blind', 'bounce', 'clip', 'drop', 'explode', 'fade', 'fold', 'puff', 'pulsate', 'scale', 'slide', and 'shake'. Default = 'fade'.
showEffectLengthnotrueintLength of time in milliseconds the show effect will last for. Default = '150'.
sizenotrueintThe number of characters used to determine the width of this field.
stylenotruejava.lang.StringCSS style(s) to be applied when this component is rendered.
styleClassnotruejava.lang.StringStyle class name of the container element.
tabindexnotruejava.lang.StringPosition of this element in the tabbing order for the current document. This value must be an integer between 0 and 32767.
textChangeListenernotruejavax.el.MethodExpressionMethodExpression 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.
titlenotruejava.lang.StringAdvisory title information about markup elements generated for this component.
validatornotruejavax.el.MethodExpressionMethodExpression 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.
validatorMessagenotruejava.lang.StringIf present, will be used as the text of the validator message, replacing any message that comes from the validator.
valuenotruejava.lang.ObjectThe current value of the simple component. The value to be rendered.
valueChangeListenernotruejavax.el.MethodExpressionMethodExpression 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".
widthnotrueintThe width of the text input field, in pixels. Default = '150'.

Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.