Tomahawk sandbox tag library.
Tag inputSuggestAjax


Provides an input textbox with "suggest" functionality, using an ajax request to the server.

A tag that defines an autosuggest control complete with Ajax binding.
This allows you to do real time autocompletion via asynchronous server requests. Note, this control is experimental and it is currently located in the MyFaces sandbox and can be subject to alteration in the immediate future. So use it with care.



Tag Information
Tag Classorg.apache.myfaces.custom.suggestajax.inputsuggestajax.InputSuggestAjaxTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
autoCompletefalsefalsejava.lang.StringIf false, the input field is not automatically populated with the first suggested value. Default: true
itemLabelMethodfalsefalsejava.lang.StringMethod which gets a suggested Object as an argument and returns a calculated String label. With this attribute it is possible to achieve the same mechanism as it can be found at select menues with the label/value pair.
suggestedItemsMethodfalsefalsejava.lang.StringReference to the method which returns the suggested items
maxSuggestedItemsfalsefalsejava.lang.Stringoptional attribute to identify the max size of suggested Values. If specified in tableSuggestAjax, paginator functionality is used.
charsetfalsefalsejava.lang.StringForce the charset of the Response
javascriptLocationfalsefalsejava.lang.StringAn alternate location to find javascript resources. If no values is specified, javascript will be loaded from the resources directory using AddResource and ExtensionsFilter.
imageLocationfalsefalsejava.lang.StringAn alternate location to find image resources. If no values is specified, images will be loaded from the resources directory using AddResource and ExtensionsFilter.
styleLocationfalsefalsejava.lang.StringAn alternate location to find stylesheet resources. If no values is specified, stylesheets will be loaded from the resources directory using AddResource and ExtensionsFilter.
disabledOnClientSidefalsefalsejava.lang.StringIf true the input is rendered disabled on the client side and a hidden input is used to actualy submit his value back to the server.
autocompletefalsefalsejava.lang.StringNon HTML standard attribute to disable browser's autocomplete function.
displayValueOnlyfalsefalsejava.lang.StringIf true, renders only the value of the component, but no input widget. Default is false.
displayValueOnlyStylefalsefalsejava.lang.StringStyle used when displayValueOnly is true.
displayValueOnlyStyleClassfalsefalsejava.lang.StringStyle class used when displayValueOnly is true.
enabledOnUserRolefalsefalsejava.lang.StringIf user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.
visibleOnUserRolefalsefalsejava.lang.StringIf 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.
forceIdfalsefalsejava.lang.StringIf true, this component will force the use of the specified id when rendering.
forceIdIndexfalsefalsejava.lang.StringIf false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)
datafldfalsefalsejava.lang.StringReserved for future use.
datasrcfalsefalsejava.lang.StringReserved for future use.
dataformatasfalsefalsejava.lang.StringReserved for future use.
alignfalsefalsejava.lang.StringHTML: Specifies the horizontal alignment of this element. Deprecated in HTML 4.01.
maxlengthfalsefalsejava.lang.StringHTML: The maximum number of characters allowed to be entered.
sizefalsefalsejava.lang.StringHTML: The initial width of this control, in characters.
stylefalsefalsejava.lang.StringHTML: CSS styling instructions.
styleClassfalsefalsejava.lang.StringThe CSS class for this element. Corresponds to the HTML 'class' attribute.
altfalsefalsejava.lang.StringHTML: Specifies alternative text that can be used by a browser that can't show this element.
tabindexfalsefalsejava.lang.StringHTML: Specifies the position of this element within the tab order of the document.
onblurfalsefalsejava.lang.StringHTML: Specifies a script to be invoked when the element loses focus.
onfocusfalsefalsejava.lang.StringHTML: Specifies a script to be invoked when the element receives focus.
accesskeyfalsefalsejava.lang.StringHTML: Sets the access key for this element.
onclickfalsefalsejava.lang.StringHTML: Script to be invoked when the element is clicked.
ondblclickfalsefalsejava.lang.StringHTML: Script to be invoked when the element is double-clicked.
onkeydownfalsefalsejava.lang.StringHTML: Script to be invoked when a key is pressed down over this element.
onkeypressfalsefalsejava.lang.StringHTML: Script to be invoked when a key is pressed over this element.
onkeyupfalsefalsejava.lang.StringHTML: Script to be invoked when a key is released over this element.
onmousedownfalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is pressed over this element.
onmousemovefalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is moved while it is in this element.
onmouseoutfalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is moves out of this element.
onmouseoverfalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is moved into this element.
onmouseupfalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is released over this element.
onchangefalsefalsejava.lang.StringHTML: Specifies a script to be invoked when the element is modified.
onselectfalsefalsejava.lang.StringHTML: Specifies a script to be invoked when the element is selected.
dirfalsefalsejava.lang.StringHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
langfalsefalsejava.lang.StringHTML: The base language of this document.
titlefalsefalsejava.lang.StringHTML: An advisory title for this element. Often used by the user agent as a tooltip.
disabledfalsefalsejava.lang.StringHTML: When true, this element cannot receive focus.
readonlyfalsefalsejava.lang.StringHTML: When true, indicates that this component cannot be modified by the user. The element may receive focus unless it has also been disabled.
validatorfalsefalsejava.lang.StringA method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.
valueChangeListenerfalsefalsejava.lang.StringA method binding EL expression, accepting a ValueChangeEvent parameter and returning void. The specified method is invoked if this component is modified. The phase that this handler is fired in can be controlled via the immediate attribute.
immediatefalsefalsejava.lang.StringA boolean value that identifies the phase during which value change events should fire. During normal event processing, value change events are fired during the "process validations" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase.
requiredfalsefalsejava.lang.StringA boolean value that indicates whether an input value is required. If this value is true, and no input value is provided, the error message javax.faces.component.UIInput.REQUIRED is posted.
converterfalsefalsejava.lang.StringThe value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface.
valuefalsefalsejava.lang.StringThe initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processed
idfalsefalsejava.lang.StringAn identifier for this particular component instance within a component view.

The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view

This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted.

renderedfalsefalsejava.lang.StringA boolean value that indicates whether this component should be rendered. Default value: true.
bindingfalsefalsejava.lang.StringIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.

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.