Package org.primefaces.component.autocomplete

Class AutoComplete

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.primefaces.component.api.AbstractPrimeHtmlInputText

org.primefaces.component.autocomplete.AutoCompleteBase

org.primefaces.component.autocomplete.AutoComplete

All Implemented Interfaces:

EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, InputHolder, MixedClientBehaviorHolder, Widget

public class AutoComplete
extends AutoCompleteBase

Nested Class Summary

Nested classes/interfaces inherited from class org.primefaces.component.autocomplete.AutoCompleteBase

AutoCompleteBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT_TYPE
static final String	DROPDOWN_CLASS
static final String	DROPDOWN_SYLE_CLASS
protected static final Collection<String>	EVENT_NAMES
static final String	INPUT_CLASS
static final String	INPUT_WITH_DROPDOWN_CLASS
static final String	ITEM_CLASS
static final String	ITEMTIP_CONTENT_CLASS
static final String	LIST_CLASS
static final String	MORE_TEXT_LIST_CLASS
static final String	MORE_TEXT_TABLE_CLASS
static final String	MULTIPLE_CONTAINER_CLASS
static final String	MULTIPLE_CONTAINER_WITH_DROPDOWN_CLASS
static final String	MULTIPLE_STYLE_CLASS
static final String	PANEL_CLASS
static final String	ROW_CLASS
static final String	STYLE_CLASS
static final String	TABLE_CLASS
static final String	TOKEN_DISPLAY_CLASS
static final String	TOKEN_ICON_CLASS
static final String	TOKEN_INPUT_CLASS
static final String	TOKEN_LABEL_CLASS
static final String	TOKEN_LABEL_DISABLED_CLASS
protected static final List<String>	UNOBSTRUSIVE_EVENT_NAMES

Fields inherited from class org.primefaces.component.autocomplete.AutoCompleteBase

COMPONENT_FAMILY, DEFAULT_RENDERER, DROPDOWN_LABEL, RESULTS_MESSAGE

Fields inherited from class javax.faces.component.UIInput

ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE, CONVERSION_MESSAGE_ID, EMPTY_STRING_AS_NULL_PARAM_NAME, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Fields inherited from interface org.primefaces.component.api.Widget

ATTR_WIDGET_VAR_PATTERN, CALLBACK_POST_CONSTRUCT, CALLBACK_POST_REFRESH, CALLBACK_PRE_DESTROY

Constructor Summary

Constructors

Constructor	Description
AutoComplete()

Method Summary

Modifier and Type	Method	Description
void	broadcast(javax.faces.event.FacesEvent event)
List<Column>	getColums()
Collection<String>	getEventNames()
String	getInputClientId()
String	getLabelledBy()
Object	getSuggestions()
Collection<String>	getUnobstrusiveEventNames()	Gets the collection of unobtrusive event names.
String	getValidatableInputClientId()
protected boolean	hasMoreSuggestions()
boolean	isClientCacheRequest(javax.faces.context.FacesContext context)
boolean	isClientQueryMode()
boolean	isDynamicLoadRequest(javax.faces.context.FacesContext context)
boolean	isHybridQueryMode()
boolean	isMoreTextRequest(javax.faces.context.FacesContext context)
boolean	isServerQueryMode()
void	queueEvent(javax.faces.event.FacesEvent event)
Object	saveState(javax.faces.context.FacesContext context)
void	setLabelledBy(String labelledBy)	Sets the id of the label for aria.

Methods inherited from class org.primefaces.component.autocomplete.AutoCompleteBase

getAppendTo, getAt, getCacheTimeout, getCompleteEndpoint, getCompleteMethod, getDropdownAriaLabel, getDropdownMode, getDropdownTabindex, getEmptyMessage, getFamily, getGroupBy, getGroupByTooltip, getInputStyle, getInputStyleClass, getItemLabel, getItemStyleClass, getItemtipAtPosition, getItemtipMyPosition, getItemValue, getLazyField, getLazyModel, getMaxResults, getMinQueryLength, getMoreText, getMy, getPanelStyle, getPanelStyleClass, getPlaceholder, getQueryDelay, getQueryEvent, getQueryMode, getResultsMessage, getScrollHeight, getSelectLimit, getType, getVar, getWidgetVar, isActive, isAutoHighlight, isAutoSelection, isCache, isDropdown, isDynamic, isEscape, isForceSelection, isMultiple, isUnique, setActive, setAppendTo, setAt, setAutoHighlight, setAutoSelection, setCache, setCacheTimeout, setCompleteEndpoint, setCompleteMethod, setDropdown, setDropdownAriaLabel, setDropdownMode, setDropdownTabindex, setDynamic, setEmptyMessage, setEscape, setForceSelection, setGroupBy, setGroupByTooltip, setInputStyle, setInputStyleClass, setItemLabel, setItemStyleClass, setItemtipAtPosition, setItemtipMyPosition, setItemValue, setLazyField, setLazyModel, setMaxResults, setMinQueryLength, setMoreText, setMultiple, setMy, setPanelStyle, setPanelStyleClass, setPlaceholder, setQueryDelay, setQueryEvent, setQueryMode, setResultsMessage, setScrollHeight, setSelectLimit, setType, setUnique, setVar, setWidgetVar

Methods inherited from class org.primefaces.component.api.AbstractPrimeHtmlInputText

getInputmode, getOncontextmenu, getOncopy, getOncut, getOndrag, getOndragend, getOndragenter, getOndragleave, getOndragover, getOndragstart, getOndrop, getOninput, getOninvalid, getOnpaste, getOnreset, getOnscroll, getOnsearch, getOnwheel, setInputmode, setOncontextmenu, setOncopy, setOncut, setOndrag, setOndragend, setOndragenter, setOndragleave, setOndragover, setOndragstart, setOndrop, setOninput, setOninvalid, setOnpaste, setOnreset, setOnscroll, setOnsearch, setOnwheel

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

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

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, restoreState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValue

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

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.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, setConverter

Methods inherited from interface org.primefaces.component.api.Widget

resolveWidgetVar, resolveWidgetVar

Field Details

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

• Constant Field Values

STYLE_CLASS

public static final String STYLE_CLASS

See Also:

• Constant Field Values

MULTIPLE_STYLE_CLASS

public static final String MULTIPLE_STYLE_CLASS

See Also:

• Constant Field Values

DROPDOWN_SYLE_CLASS

public static final String DROPDOWN_SYLE_CLASS

See Also:

• Constant Field Values

INPUT_CLASS

public static final String INPUT_CLASS

See Also:

• Constant Field Values

INPUT_WITH_DROPDOWN_CLASS

public static final String INPUT_WITH_DROPDOWN_CLASS

See Also:

• Constant Field Values

DROPDOWN_CLASS

public static final String DROPDOWN_CLASS

See Also:

• Constant Field Values

PANEL_CLASS

public static final String PANEL_CLASS

See Also:

• Constant Field Values

LIST_CLASS

public static final String LIST_CLASS

See Also:

• Constant Field Values

TABLE_CLASS

public static final String TABLE_CLASS

See Also:

• Constant Field Values

ITEM_CLASS

public static final String ITEM_CLASS

See Also:

• Constant Field Values

ROW_CLASS

public static final String ROW_CLASS

See Also:

• Constant Field Values

TOKEN_DISPLAY_CLASS

public static final String TOKEN_DISPLAY_CLASS

See Also:

• Constant Field Values

TOKEN_LABEL_CLASS

public static final String TOKEN_LABEL_CLASS

See Also:

• Constant Field Values

TOKEN_LABEL_DISABLED_CLASS

public static final String TOKEN_LABEL_DISABLED_CLASS

See Also:

• Constant Field Values

TOKEN_ICON_CLASS

public static final String TOKEN_ICON_CLASS

See Also:

• Constant Field Values

TOKEN_INPUT_CLASS

public static final String TOKEN_INPUT_CLASS

See Also:

• Constant Field Values

MULTIPLE_CONTAINER_CLASS

public static final String MULTIPLE_CONTAINER_CLASS

See Also:

• Constant Field Values

MULTIPLE_CONTAINER_WITH_DROPDOWN_CLASS

public static final String MULTIPLE_CONTAINER_WITH_DROPDOWN_CLASS

See Also:

• Constant Field Values

ITEMTIP_CONTENT_CLASS

public static final String ITEMTIP_CONTENT_CLASS

See Also:

• Constant Field Values

MORE_TEXT_LIST_CLASS

public static final String MORE_TEXT_LIST_CLASS

See Also:

• Constant Field Values

MORE_TEXT_TABLE_CLASS

public static final String MORE_TEXT_TABLE_CLASS

See Also:

• Constant Field Values

UNOBSTRUSIVE_EVENT_NAMES

protected static final List<String> UNOBSTRUSIVE_EVENT_NAMES

EVENT_NAMES

protected static final Collection<String> EVENT_NAMES

Constructor Details

AutoComplete

public AutoComplete()

Method Details

getEventNames

public Collection<String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class AbstractPrimeHtmlInputText

getUnobstrusiveEventNames

public Collection<String> getUnobstrusiveEventNames()

Description copied from interface: MixedClientBehaviorHolder

Gets the collection of unobtrusive event names.

Returns:

the collection of unobtrusive event names.

isMoreTextRequest

public boolean isMoreTextRequest(javax.faces.context.FacesContext context)

isDynamicLoadRequest

public boolean isDynamicLoadRequest(javax.faces.context.FacesContext context)

isClientCacheRequest

public boolean isClientCacheRequest(javax.faces.context.FacesContext context)

queueEvent

public void queueEvent(javax.faces.event.FacesEvent event)

Overrides:

queueEvent in class javax.faces.component.UIComponentBase

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Overrides:

broadcast in class javax.faces.component.UIComponentBase

Throws:

javax.faces.event.AbortProcessingException

hasMoreSuggestions

protected boolean hasMoreSuggestions()

getColums

public List<Column> getColums()

getSuggestions

public Object getSuggestions()

isServerQueryMode

public boolean isServerQueryMode()

isClientQueryMode

public boolean isClientQueryMode()

isHybridQueryMode

public boolean isHybridQueryMode()

getInputClientId

public String getInputClientId()

Returns:

Client id of the input element

getValidatableInputClientId

public String getValidatableInputClientId()

Returns:

Client id of the validatable input element

getLabelledBy

public String getLabelledBy()

Returns:

Client id of the label for aria

setLabelledBy

public void setLabelledBy(String labelledBy)

Description copied from interface: InputHolder

Sets the id of the label for aria.

Parameters:

labelledBy - the id

saveState

public Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIInput