org.apache.myfaces.custom.suggestajax.inputsuggestajax
Class AbstractInputSuggestAjax

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              javax.faces.component.UIInput
                  javax.faces.component.html.HtmlInputText
                      org.apache.myfaces.component.html.ext.AbstractHtmlInputText
                          org.apache.myfaces.component.html.ext.HtmlInputText
                              org.apache.myfaces.custom.suggestajax.AbstractSuggestAjax
                                  org.apache.myfaces.custom.suggestajax.SuggestAjax
                                      org.apache.myfaces.custom.suggestajax.inputsuggestajax.AbstractInputSuggestAjax

All Implemented Interfaces:

javax.faces.component.EditableValueHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, org.apache.myfaces.component.AlignProperty, org.apache.myfaces.component.DataProperties, org.apache.myfaces.component.DisplayValueOnlyAware, org.apache.myfaces.component.ForceIdAware, org.apache.myfaces.component.LocationAware, org.apache.myfaces.component.UserRoleAware, AjaxComponent, org.apache.myfaces.shared_tomahawk.component.DisplayValueOnlyCapable

Direct Known Subclasses:

InputSuggestAjax

public abstract class AbstractInputSuggestAjax
extends SuggestAjax

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.

Version:

$Revision: 673833 $ $Date: 2008-07-03 16:58:05 -0500 (Thu, 03 Jul 2008) $

Author:

Gerald Muellan (latest modification by $Author: skitching $), Martin Marinschek

Field Summary

static java.lang.String	COMPONENT_TYPE
static java.lang.String	DEFAULT_RENDERER_TYPE

Fields inherited from class org.apache.myfaces.custom.suggestajax.SuggestAjax

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIInput

CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID

Fields inherited from interface org.apache.myfaces.component.UserRoleAware

ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR

Fields inherited from interface org.apache.myfaces.shared_tomahawk.component.DisplayValueOnlyCapable

DISPLAY_VALUE_ONLY_ATTR, DISPLAY_VALUE_ONLY_STYLE_ATTR, DISPLAY_VALUE_ONLY_STYLE_CLASS_ATTR

Constructor Summary

AbstractInputSuggestAjax()

Method Summary

void	encodeChildren(javax.faces.context.FacesContext context)
abstract java.lang.Boolean	getAutoComplete() If false, the input field is not automatically populated with the first suggested value.
abstract javax.faces.el.MethodBinding	getItemLabelMethod() Method which gets a suggested Object as an argument and returns a calculated String label.

Methods inherited from class org.apache.myfaces.custom.suggestajax.SuggestAjax

getCharset, getFamily, getImageLocation, getJavascriptLocation, getMaxSuggestedItems, getStyleLocation, restoreState, saveState, setCharset, setImageLocation, setJavascriptLocation, setMaxSuggestedItems, setStyleLocation

Methods inherited from class org.apache.myfaces.custom.suggestajax.AbstractSuggestAjax

decodeAjax, encodeAjax, getSuggestedItemsMethod, setSuggestedItemsMethod

Methods inherited from class org.apache.myfaces.component.html.ext.HtmlInputText

getAlign, getAutocomplete, getDatafld, getDataformatas, getDatasrc, getDisplayValueOnly, getDisplayValueOnlyStyle, getDisplayValueOnlyStyleClass, getEnabledOnUserRole, getVisibleOnUserRole, isDisabledOnClientSide, isForceId, isForceIdIndex, setAlign, setAutocomplete, setDatafld, setDataformatas, setDatasrc, setDisabledOnClientSide, setDisplayValueOnly, setDisplayValueOnlyStyle, setDisplayValueOnlyStyleClass, setEnabledOnUserRole, setForceId, setForceIdIndex, setVisibleOnUserRole

Methods inherited from class org.apache.myfaces.component.html.ext.AbstractHtmlInputText

getClientId, isDisplayValueOnly, isRendered, isSetDisplayValueOnly, setDisplayValueOnly

Methods inherited from class javax.faces.component.html.HtmlInputText

getAccesskey, getAlt, getDir, getLang, getMaxlength, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getSize, getStyle, getStyleClass, getTabindex, getTitle, isDisabled, isReadonly, setAccesskey, setAlt, setDir, setDisabled, setLang, setMaxlength, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setSize, setStyle, setStyleClass, setTabindex, setTitle

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, broadcast, compareValues, decode, getConvertedValue, getSubmittedValue, getValidator, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, setImmediate, setLocalValueSet, setRequired, setSubmittedValue, setValid, setValidator, setValue, setValueChangeListener, updateModel, validate, validateValue

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, encodeBegin, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, setConverter

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

DEFAULT_RENDERER_TYPE

public static final java.lang.String DEFAULT_RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

AbstractInputSuggestAjax

public AbstractInputSuggestAjax()

Method Detail

encodeChildren

public void encodeChildren(javax.faces.context.FacesContext context)
                    throws java.io.IOException

Overrides:

encodeChildren in class AbstractSuggestAjax

Throws:

java.io.IOException

getAutoComplete

public abstract java.lang.Boolean getAutoComplete()

If false, the input field is not automatically populated with the first suggested value. Default: true

Returns:

getItemLabelMethod

public abstract javax.faces.el.MethodBinding getItemLabelMethod()

Method 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.

Returns: