@Generated(value="com.liferay.alloy.tools.builder.FacesBuilder") public abstract class AutoCompleteBase extends InputTextBase implements com.liferay.faces.util.component.Styleable, com.liferay.faces.util.component.ClientComponent
Modifier and Type | Class and Description |
---|---|
protected static class |
AutoCompleteBase.AutoCompletePropertyKeys |
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENT_TYPE |
static String |
RENDERER_TYPE |
COMPONENT_FAMILY, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME
Constructor and Description |
---|
AutoCompleteBase() |
Modifier and Type | Method and Description |
---|---|
Boolean |
getAutoScroll()
autoScroll attribute description: |
Boolean |
getCircular()
circular attribute description: |
String |
getClientCustomFilter()
clientCustomFilter attribute description: |
String |
getClientFilterType()
clientFilterType attribute description: |
String |
getClientKey()
clientKey attribute description: |
Integer |
getDelay()
delay attribute description: |
String |
getDelimiter()
delimiter attribute description: |
String |
getHeight()
height attribute description: |
String |
getHighlighterType()
highlighterType attribute description: |
Integer |
getMaxItems()
maxItems attribute description: |
Integer |
getMinChars()
minChars attribute description: |
javax.el.MethodExpression |
getServerCustomFilter()
serverCustomFilter attribute description: |
String |
getServerFilterType()
serverFilterType attribute description: |
String |
getStyleClass()
styleClass attribute description: |
String |
getWidth()
width attribute description: |
boolean |
isActivateFirstItem()
activateFirstItem attribute description: |
boolean |
isListItemRequired()
listItemRequired attribute description: |
boolean |
isTabSelect()
tabSelect attribute description: |
void |
setActivateFirstItem(boolean activateFirstItem)
activateFirstItem attribute description: |
void |
setAutoScroll(Boolean autoScroll)
autoScroll attribute description: |
void |
setCircular(Boolean circular)
circular attribute description: |
void |
setClientCustomFilter(String clientCustomFilter)
clientCustomFilter attribute description: |
void |
setClientFilterType(String clientFilterType)
clientFilterType attribute description: |
void |
setClientKey(String clientKey)
clientKey attribute description: |
void |
setDelay(Integer delay)
delay attribute description: |
void |
setDelimiter(String delimiter)
delimiter attribute description: |
void |
setHeight(String height)
height attribute description: |
void |
setHighlighterType(String highlighterType)
highlighterType attribute description: |
void |
setListItemRequired(boolean listItemRequired)
listItemRequired attribute description: |
void |
setMaxItems(Integer maxItems)
maxItems attribute description: |
void |
setMinChars(Integer minChars)
minChars attribute description: |
void |
setServerCustomFilter(javax.el.MethodExpression serverCustomFilter)
serverCustomFilter attribute description: |
void |
setServerFilterType(String serverFilterType)
serverFilterType attribute description: |
void |
setTabSelect(boolean tabSelect)
tabSelect attribute description: |
void |
setWidth(String width)
width attribute description: |
getLabel
getAccesskey, getAlt, getAutocomplete, getDefaultEventName, getDir, getEventNames, getLang, getMaxlength, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getRole, getSize, getStyle, 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
addValidator, addValueChangeListener, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getFamily, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, restoreState, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValue
getConverter, getLocalValue, setConverter
addClientBehavior, addFacesListener, broadcast, 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, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent
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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getStyle, setStyle, setStyleClass
public static final String COMPONENT_TYPE
public static final String RENDERER_TYPE
public boolean isActivateFirstItem()
activateFirstItem
attribute description:
public void setActivateFirstItem(boolean activateFirstItem)
activateFirstItem
attribute description:
public Boolean getAutoScroll()
autoScroll
attribute description:
public void setAutoScroll(Boolean autoScroll)
autoScroll
attribute description:
public Boolean getCircular()
circular
attribute description:
true
.public void setCircular(Boolean circular)
circular
attribute description:
true
.public String getClientCustomFilter()
clientCustomFilter
attribute description:
query
and source
arguments and returns an array of String
s as a result. The source
argument recieved by this callback is an Array
of Object
s which contain three properties: display
, raw
, and text
. Note: This attribute will be ignored if the serverCustomFilter
or serverFilterType
attributes are used.public void setClientCustomFilter(String clientCustomFilter)
clientCustomFilter
attribute description:
query
and source
arguments and returns an array of String
s as a result. The source
argument recieved by this callback is an Array
of Object
s which contain three properties: display
, raw
, and text
. Note: This attribute will be ignored if the serverCustomFilter
or serverFilterType
attributes are used.public String getClientFilterType()
clientFilterType
attribute description:
serverCustomFilter
, serverFilterType
, or clientCustomFilter
attributes are used.public void setClientFilterType(String clientFilterType)
clientFilterType
attribute description:
serverCustomFilter
, serverFilterType
, or clientCustomFilter
attributes are used.public String getClientKey()
clientKey
attribute description:
getClientKey
in interface com.liferay.faces.util.component.ClientComponent
public void setClientKey(String clientKey)
clientKey
attribute description:
setClientKey
in interface com.liferay.faces.util.component.ClientComponent
public Integer getDelay()
delay
attribute description:
autoComplete
receives input, it waits the specified number of milliseconds before sending a request for filtering it's source. If input occurs before the specified number of milliseconds has elapsed, the timer is reset.public void setDelay(Integer delay)
delay
attribute description:
autoComplete
receives input, it waits the specified number of milliseconds before sending a request for filtering it's source. If input occurs before the specified number of milliseconds has elapsed, the timer is reset.public String getDelimiter()
delimiter
attribute description:
delimiter=" "
, then only the text after the final space will have completion. Note: if listItemRequired="true"
, this attribute is ignored.public void setDelimiter(String delimiter)
delimiter
attribute description:
delimiter=" "
, then only the text after the final space will have completion. Note: if listItemRequired="true"
, this attribute is ignored.public String getHeight()
height
attribute description:
public void setHeight(String height)
height
attribute description:
public String getHighlighterType()
highlighterType
attribute description:
public void setHighlighterType(String highlighterType)
highlighterType
attribute description:
public boolean isListItemRequired()
listItemRequired
attribute description:
public void setListItemRequired(boolean listItemRequired)
listItemRequired
attribute description:
public Integer getMaxItems()
maxItems
attribute description:
public void setMaxItems(Integer maxItems)
maxItems
attribute description:
public Integer getMinChars()
minChars
attribute description:
public void setMinChars(Integer minChars)
minChars
attribute description:
public javax.el.MethodExpression getServerCustomFilter()
serverCustomFilter
attribute description:
public
, return a java.util.List<java.lang.String>
, and takes a java.lang.String
and a java.util.List<java.lang.String>
as a arguments. The String
passed to the method is the current query. The List<String>
is an immutable list of unfiltered results. The method must return a List<String>
which contains the filtered results.public void setServerCustomFilter(javax.el.MethodExpression serverCustomFilter)
serverCustomFilter
attribute description:
public
, return a java.util.List<java.lang.String>
, and takes a java.lang.String
and a java.util.List<java.lang.String>
as a arguments. The String
passed to the method is the current query. The List<String>
is an immutable list of unfiltered results. The method must return a List<String>
which contains the filtered results.public String getServerFilterType()
serverFilterType
attribute description:
serverCustomFilter
attribute is used.public void setServerFilterType(String serverFilterType)
serverFilterType
attribute description:
serverCustomFilter
attribute is used.public String getStyleClass()
styleClass
attribute description:
getStyleClass
in interface com.liferay.faces.util.component.Styleable
getStyleClass
in class InputTextBase
public boolean isTabSelect()
tabSelect
attribute description:
true
, pressing TAB selects the active autoComplete option.public void setTabSelect(boolean tabSelect)
tabSelect
attribute description:
true
, pressing TAB selects the active autoComplete option.public String getWidth()
width
attribute description:
public void setWidth(String width)
width
attribute description:
Copyright © 2019 Liferay, Inc.. All rights reserved.