@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:
When true, if the active option of the autoComplete is not in view, the view will be scrolled to ensure that the active option is displayed to the user. |
Boolean |
getCircular()
circular attribute description:
When true, the autoComplete list will wrap around allowing users to use keyboard navigation to move from the top of the list to the bottom and vice versa. |
String |
getClientCustomFilter()
clientCustomFilter attribute description:
A callback which filters the client-side results. |
String |
getClientFilterType()
clientFilterType attribute description:
Specifies the type of filter that will be used for the autoComplete results. |
String |
getClientKey()
clientKey attribute description:
The key name that can be used to reference the component on the client. |
Integer |
getDelay()
delay attribute description:
The delay in milliseconds before a request for filtering occurs. |
String |
getDelimiter()
delimiter attribute description:
The string which delimits the part of the text that will have completion. |
String |
getHeight()
height attribute description:
The the height (in pixels) of the rendered autoComplete list. |
String |
getHighlighterType()
highlighterType attribute description:
Specifies the type of highlighter that will be used for the autoComplete results. |
Integer |
getMaxItems()
maxItems attribute description:
The maximum amount of autoComplete results. |
Integer |
getMinChars()
minChars attribute description:
The minimum length of input required to trigger a query. |
javax.el.MethodExpression |
getServerCustomFilter()
serverCustomFilter attribute description:
A method that is executed when a query occurs. |
String |
getServerFilterType()
serverFilterType attribute description:
Specifies the type of filter that will be used for the autoComplete results. |
String |
getStyleClass()
styleClass attribute description:
List of CSS class names (separated by spaces) that are to be rendered within the class attribute. |
String |
getWidth()
width attribute description:
The the width (in pixels) of the rendered autoComplete list. |
boolean |
isActivateFirstItem()
activateFirstItem attribute description:
When true, the first item in the list will be activated so that users can press TAB or ENTER to select it. |
boolean |
isListItemRequired()
listItemRequired attribute description:
When true, the component will perform server-side validation to ensure that the value entered is on the list of completion items. |
boolean |
isTabSelect()
tabSelect attribute description:
When true, pressing TAB selects the active autoComplete option. |
void |
setActivateFirstItem(boolean activateFirstItem)
activateFirstItem attribute description:
When true, the first item in the list will be activated so that users can press TAB or ENTER to select it. |
void |
setAutoScroll(Boolean autoScroll)
autoScroll attribute description:
When true, if the active option of the autoComplete is not in view, the view will be scrolled to ensure that the active option is displayed to the user. |
void |
setCircular(Boolean circular)
circular attribute description:
When true, the autoComplete list will wrap around allowing users to use keyboard navigation to move from the top of the list to the bottom and vice versa. |
void |
setClientCustomFilter(String clientCustomFilter)
clientCustomFilter attribute description:
A callback which filters the client-side results. |
void |
setClientFilterType(String clientFilterType)
clientFilterType attribute description:
Specifies the type of filter that will be used for the autoComplete results. |
void |
setClientKey(String clientKey)
clientKey attribute description:
The key name that can be used to reference the component on the client. |
void |
setDelay(Integer delay)
delay attribute description:
The delay in milliseconds before a request for filtering occurs. |
void |
setDelimiter(String delimiter)
delimiter attribute description:
The string which delimits the part of the text that will have completion. |
void |
setHeight(String height)
height attribute description:
The the height (in pixels) of the rendered autoComplete list. |
void |
setHighlighterType(String highlighterType)
highlighterType attribute description:
Specifies the type of highlighter that will be used for the autoComplete results. |
void |
setListItemRequired(boolean listItemRequired)
listItemRequired attribute description:
When true, the component will perform server-side validation to ensure that the value entered is on the list of completion items. |
void |
setMaxItems(Integer maxItems)
maxItems attribute description:
The maximum amount of autoComplete results. |
void |
setMinChars(Integer minChars)
minChars attribute description:
The minimum length of input required to trigger a query. |
void |
setServerCustomFilter(javax.el.MethodExpression serverCustomFilter)
serverCustomFilter attribute description:
A method that is executed when a query occurs. |
void |
setServerFilterType(String serverFilterType)
serverFilterType attribute description:
Specifies the type of filter that will be used for the autoComplete results. |
void |
setTabSelect(boolean tabSelect)
tabSelect attribute description:
When true, pressing TAB selects the active autoComplete option. |
void |
setWidth(String width)
width attribute description:
The the width (in pixels) of the rendered autoComplete list. |
getLabelgetAccesskey, 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, setTitleaddValidator, 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, validateValuegetConverter, getLocalValue, setConverteraddClientBehavior, 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, unsubscribeFromEventencodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTreeclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetStyle, setStyle, setStyleClasspublic 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 Strings as a result. The source argument recieved by this callback is an Array of Objects 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 Strings as a result. The source argument recieved by this callback is an Array of Objects 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.ClientComponentpublic void setClientKey(String clientKey)
clientKey attribute description:
setClientKey in interface com.liferay.faces.util.component.ClientComponentpublic 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.StyleablegetStyleClass in class InputTextBasepublic 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 © 2016 Liferay, Inc.. All rights reserved.