public abstract class AutoCompleteEntryBase extends javax.faces.component.html.HtmlInputText implements IAutoCompleteEntry, IceClientBehaviorHolder
For more information, see the AutoCompleteEntry Wiki Documentation.
| Modifier and Type | Class and Description |
|---|---|
protected static class |
AutoCompleteEntryBase.PropertyKeys |
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
COMPONENT_TYPE |
static java.lang.String |
RENDERER_TYPE |
| Constructor and Description |
|---|
AutoCompleteEntryBase() |
| Modifier and Type | Method and Description |
|---|---|
void |
addClientBehavior(java.lang.String eventName,
javax.faces.component.behavior.ClientBehavior behavior) |
java.lang.String |
getDefaultEventName() |
java.lang.String |
getDefaultExecute(java.lang.String event) |
java.lang.String |
getDefaultRender(java.lang.String event) |
int |
getDelay()
Return the value of the
delay property. |
java.lang.String |
getDirection()
Return the value of the
direction property. |
java.util.Collection<java.lang.String> |
getEventNames() |
java.lang.String |
getFamily() |
java.lang.Object |
getFilterBy()
Return the value of the
filterBy property. |
java.lang.String |
getFilterMatchMode()
Return the value of the
filterMatchMode property. |
int |
getHeight()
Return the value of the
height property. |
java.lang.String |
getHideEffect()
Return the value of the
hideEffect property. |
int |
getHideEffectLength()
Return the value of the
hideEffectLength property. |
java.lang.String |
getIndicatorPosition()
Return the value of the
indicatorPosition property. |
java.util.List |
getItemList()
Return the value of the
itemList property. |
java.lang.String |
getLabelPosition()
Return the value of the
labelPosition property. |
java.lang.String |
getListenerArgument(java.lang.String event) |
java.util.List |
getListValue()
Return the value of the
listValue property. |
java.lang.String |
getListVar()
Return the value of the
listVar property. |
int |
getMinChars()
Return the value of the
minChars property. |
java.lang.String |
getOptionalIndicator()
Return the value of the
optionalIndicator property. |
java.lang.String |
getPlaceholder()
Return the value of the
placeholder property. |
java.lang.String |
getRequiredIndicator()
Return the value of the
requiredIndicator property. |
int |
getRows()
Return the value of the
rows property. |
java.lang.String |
getShowEffect()
Return the value of the
showEffect property. |
int |
getShowEffectLength()
Return the value of the
showEffectLength property. |
java.lang.String |
getSubmittedText()
Return the value of the
submittedText property. |
java.lang.String |
getText()
Return the value of the
text property. |
javax.el.MethodExpression |
getTextChangeListener()
Return the value of the
textChangeListener property. |
int |
getWidth()
Return the value of the
width property. |
boolean |
isCaseSensitive()
Return the value of the
caseSensitive property. |
boolean |
isClientSide()
Return the value of the
clientSide property. |
java.lang.Boolean |
isPopulateList()
Return the value of the
populateList property. |
protected boolean |
isPropertySet(java.lang.String finder) |
boolean |
isReset()
Return the value of the
reset property. |
void |
setCaseSensitive(boolean caseSensitive)
Set the value of the
caseSensitive property. |
void |
setClientSide(boolean clientSide)
Set the value of the
clientSide property. |
void |
setDelay(int delay)
Set the value of the
delay property. |
void |
setDirection(java.lang.String direction)
Set the value of the
direction property. |
void |
setFilterBy(java.lang.Object filterBy)
Set the value of the
filterBy property. |
void |
setFilterMatchMode(java.lang.String filterMatchMode)
Set the value of the
filterMatchMode property. |
void |
setHeight(int height)
Set the value of the
height property. |
void |
setHideEffect(java.lang.String hideEffect)
Set the value of the
hideEffect property. |
void |
setHideEffectLength(int hideEffectLength)
Set the value of the
hideEffectLength property. |
void |
setIndicatorPosition(java.lang.String indicatorPosition)
Set the value of the
indicatorPosition property. |
void |
setItemList(java.util.List itemList)
Set the value of the
itemList property. |
void |
setLabelPosition(java.lang.String labelPosition)
Set the value of the
labelPosition property. |
void |
setListValue(java.util.List listValue)
Set the value of the
listValue property. |
void |
setListVar(java.lang.String listVar)
Set the value of the
listVar property. |
void |
setMinChars(int minChars)
Set the value of the
minChars property. |
void |
setOptionalIndicator(java.lang.String optionalIndicator)
Set the value of the
optionalIndicator property. |
void |
setPlaceholder(java.lang.String placeholder)
Set the value of the
placeholder property. |
void |
setPopulateList(java.lang.Boolean populateList)
Set the value of the
populateList property. |
void |
setRequiredIndicator(java.lang.String requiredIndicator)
Set the value of the
requiredIndicator property. |
void |
setReset(boolean reset)
Set the value of the
reset property. |
void |
setRows(int rows)
Set the value of the
rows property. |
void |
setShowEffect(java.lang.String showEffect)
Set the value of the
showEffect property. |
void |
setShowEffectLength(int showEffectLength)
Set the value of the
showEffectLength property. |
void |
setSubmittedText(java.lang.String submittedText)
Set the value of the
submittedText property. |
void |
setText(java.lang.String text)
Set the value of the
text property. |
void |
setTextChangeListener(javax.el.MethodExpression textChangeListener)
Set the value of the
textChangeListener property. |
void |
setValueExpression(java.lang.String name,
javax.el.ValueExpression binding) |
void |
setWidth(int width)
Set the value of the
width property. |
getAccesskey, getAlt, getAutocomplete, 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, setTitleaddValidator, 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, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValuegetConverter, getLocalValue, setConverteraddFacesListener, 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, visitTreeclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic static final java.lang.String COMPONENT_TYPE
public static final java.lang.String RENDERER_TYPE
public java.lang.String getFamily()
getFamily in class javax.faces.component.UIInputpublic void setCaseSensitive(boolean caseSensitive)
Set the value of the caseSensitive property.
Contents: Boolean value that indicates whether the filtering should be case sensitive or not.
setCaseSensitive in interface IAutoCompleteEntrypublic boolean isCaseSensitive()
Return the value of the caseSensitive property.
Contents: Boolean value that indicates whether the filtering should be case sensitive or not. Default = 'false'.
isCaseSensitive in interface IAutoCompleteEntrypublic void setClientSide(boolean clientSide)
Set the value of the clientSide property.
Contents: Boolean value that indicates whether the autocomplete functionality should be done on the client or on the server. Client-side mode can be faster, as no round trips to the server need to be made. However, if the list of possible results is too large, the browser might become slower, since the entire list has to be stored in the client as HTML nodes. It is recommended not to use lists of more than 1000 items when using the client-side mode.
setClientSide in interface IAutoCompleteEntrypublic boolean isClientSide()
Return the value of the clientSide property.
Contents: Boolean value that indicates whether the autocomplete functionality should be done on the client or on the server. Client-side mode can be faster, as no round trips to the server need to be made. However, if the list of possible results is too large, the browser might become slower, since the entire list has to be stored in the client as HTML nodes. It is recommended not to use lists of more than 1000 items when using the client-side mode. Default = 'false'.
isClientSide in interface IAutoCompleteEntrypublic void setDelay(int delay)
Set the value of the delay property.
Contents: Delay in milliseconds for showing the list of possible matches after typing a character.
setDelay in interface IAutoCompleteEntrypublic int getDelay()
Return the value of the delay property.
Contents: Delay in milliseconds for showing the list of possible matches after typing a character. Default = '250'.
getDelay in interface IAutoCompleteEntrypublic void setDirection(java.lang.String direction)
Set the value of the direction property.
Contents: Direction in which to show the list of possible matches. Possible values are "up", "down", and "auto".
setDirection in interface IAutoCompleteEntrypublic java.lang.String getDirection()
Return the value of the direction property.
Contents: Direction in which to show the list of possible matches. Possible values are "up", "down", and "auto".
getDirection in interface IAutoCompleteEntrypublic void setFilterBy(java.lang.Object filterBy)
Set the value of the filterBy property.
Contents: ValueExpression that specifies the property of the data object to use for filtering values. This only applies when listvar is used and the rendering is done by means of a facet.
setFilterBy in interface IAutoCompleteEntrypublic java.lang.Object getFilterBy()
Return the value of the filterBy property.
Contents: ValueExpression that specifies the property of the data object to use for filtering values. This only applies when listvar is used and the rendering is done by means of a facet.
getFilterBy in interface IAutoCompleteEntrypublic void setFilterMatchMode(java.lang.String filterMatchMode)
Set the value of the filterMatchMode property.
Contents: Defines the method of filter comparison used, default is "startsWith". Types available include: "contains", "exact", "startsWith", "endsWith" and "none". Typically, "none" will be used in cases where more complex, custom filtering is needed or when option values need to be loaded lazily (e.g. from a data base).
setFilterMatchMode in interface IAutoCompleteEntrypublic java.lang.String getFilterMatchMode()
Return the value of the filterMatchMode property.
Contents: Defines the method of filter comparison used, default is "startsWith". Types available include: "contains", "exact", "startsWith", "endsWith" and "none". Typically, "none" will be used in cases where more complex, custom filtering is needed or when option values need to be loaded lazily (e.g. from a data base). Default = 'startsWith'.
getFilterMatchMode in interface IAutoCompleteEntrypublic void setHeight(int height)
Set the value of the height property.
Contents: Maximum height in pixels of the list of possible matches (if 0, then the size is automatically adjusted to show all possible matches).
setHeight in interface IAutoCompleteEntrypublic int getHeight()
Return the value of the height property.
Contents: Maximum height in pixels of the list of possible matches (if 0, then the size is automatically adjusted to show all possible matches).
getHeight in interface IAutoCompleteEntrypublic void setHideEffect(java.lang.String hideEffect)
Set the value of the hideEffect property.
Contents: Effect to use when hiding the list. Possible values are 'blind', 'bounce', 'clip', 'drop', 'explode', 'fade', 'fold', 'puff', 'pulsate', 'scale', and 'slide'.
setHideEffect in interface IAutoCompleteEntrypublic java.lang.String getHideEffect()
Return the value of the hideEffect property.
Contents: Effect to use when hiding the list. Possible values are 'blind', 'bounce', 'clip', 'drop', 'explode', 'fade', 'fold', 'puff', 'pulsate', 'scale', and 'slide'. Default = 'fade'.
getHideEffect in interface IAutoCompleteEntrypublic void setHideEffectLength(int hideEffectLength)
Set the value of the hideEffectLength property.
Contents: Length of time in milliseconds the hide effect will last for.
setHideEffectLength in interface IAutoCompleteEntrypublic int getHideEffectLength()
Return the value of the hideEffectLength property.
Contents: Length of time in milliseconds the hide effect will last for. Default = '150'.
getHideEffectLength in interface IAutoCompleteEntrypublic void setIndicatorPosition(java.lang.String indicatorPosition)
Set the value of the indicatorPosition property.
Contents: Position of input-required or input-optional indicator relative to input field or label. Supported values are "left/right/top/bottom/labelLeft/labelRight/none". Default is "labelRight" if labelPosition is "inField", "right" otherwise.
setIndicatorPosition in interface IAutoCompleteEntrypublic java.lang.String getIndicatorPosition()
Return the value of the indicatorPosition property.
Contents: Position of input-required or input-optional indicator relative to input field or label. Supported values are "left/right/top/bottom/labelLeft/labelRight/none". Default is "labelRight" if labelPosition is "inField", "right" otherwise.
getIndicatorPosition in interface IAutoCompleteEntrypublic void setLabelPosition(java.lang.String labelPosition)
Set the value of the labelPosition property.
Contents: Position of label relative to input field. Supported values are "left/right/top/bottom/inField/none". Default is "none".
setLabelPosition in interface IAutoCompleteEntrypublic java.lang.String getLabelPosition()
Return the value of the labelPosition property.
Contents: Position of label relative to input field. Supported values are "left/right/top/bottom/inField/none". Default is "none".
getLabelPosition in interface IAutoCompleteEntrypublic void setListValue(java.util.List listValue)
Set the value of the listValue property.
Contents: When rendering via a facet, this attribute specifies the list of data objects that contains all possible options.
setListValue in interface IAutoCompleteEntrypublic java.util.List getListValue()
Return the value of the listValue property.
Contents: When rendering via a facet, this attribute specifies the list of data objects that contains all possible options.
getListValue in interface IAutoCompleteEntrypublic void setListVar(java.lang.String listVar)
Set the value of the listVar property.
Contents: Variable name to use for referencing each data object in the list when rendering via a facet.
setListVar in interface IAutoCompleteEntrypublic java.lang.String getListVar()
Return the value of the listVar property.
Contents: Variable name to use for referencing each data object in the list when rendering via a facet.
getListVar in interface IAutoCompleteEntrypublic void setMinChars(int minChars)
Set the value of the minChars property.
Contents: Minimum number of characters that must be in the text field before submitting and before producing the list of possible matches.
setMinChars in interface IAutoCompleteEntrypublic int getMinChars()
Return the value of the minChars property.
Contents: Minimum number of characters that must be in the text field before submitting and before producing the list of possible matches. Default = '0'.
getMinChars in interface IAutoCompleteEntrypublic void setOptionalIndicator(java.lang.String optionalIndicator)
Set the value of the optionalIndicator property.
Contents: Indicator indicating that the user is NOT required to provide a submitted value for this input component.
setOptionalIndicator in interface IAutoCompleteEntrypublic java.lang.String getOptionalIndicator()
Return the value of the optionalIndicator property.
Contents: Indicator indicating that the user is NOT required to provide a submitted value for this input component.
getOptionalIndicator in interface IAutoCompleteEntrypublic void setPlaceholder(java.lang.String placeholder)
Set the value of the placeholder property.
Contents: The HTML5 placeholder attribute represents a short hint (a word or short phrase) intended to aid the user with data entry when the input element has no value. If the placeholder attribute is not supported by the browser, the label 'inField' functionality will be used instead. Alternatively, the Mojarra HTML5 'placeholder' passthrough attribute may also be used with this component.
setPlaceholder in interface IAutoCompleteEntrypublic java.lang.String getPlaceholder()
Return the value of the placeholder property.
Contents: The HTML5 placeholder attribute represents a short hint (a word or short phrase) intended to aid the user with data entry when the input element has no value. If the placeholder attribute is not supported by the browser, the label 'inField' functionality will be used instead. Alternatively, the Mojarra HTML5 'placeholder' passthrough attribute may also be used with this component.
getPlaceholder in interface IAutoCompleteEntrypublic void setRequiredIndicator(java.lang.String requiredIndicator)
Set the value of the requiredIndicator property.
Contents: Indicator indicating that the user is required to provide a submitted value for this input component.
setRequiredIndicator in interface IAutoCompleteEntrypublic java.lang.String getRequiredIndicator()
Return the value of the requiredIndicator property.
Contents: Indicator indicating that the user is required to provide a submitted value for this input component.
getRequiredIndicator in interface IAutoCompleteEntrypublic void setReset(boolean reset)
Set the value of the reset property.
Contents: Flag to reset the component values completely. This component internally stores a number of temporary values to perform its functions. Since these values are not accessible to the app developer, they might linger after resetting the main value. Set this flag to true to completely reset all these temporary internal values. These values will be reset in the RENDER_RESPONSE phase. After that, this flag will automatically be set to false again. Typically this flag will be set in an action listener. When setting this flag to true, it is also advised to set the property bound to this component's value to null.
setReset in interface IAutoCompleteEntrypublic boolean isReset()
Return the value of the reset property.
Contents: Flag to reset the component values completely. This component internally stores a number of temporary values to perform its functions. Since these values are not accessible to the app developer, they might linger after resetting the main value. Set this flag to true to completely reset all these temporary internal values. These values will be reset in the RENDER_RESPONSE phase. After that, this flag will automatically be set to false again. Typically this flag will be set in an action listener. When setting this flag to true, it is also advised to set the property bound to this component's value to null. Default = 'false'.
isReset in interface IAutoCompleteEntrypublic void setRows(int rows)
Set the value of the rows property.
Contents: The maximum number of possible options to show to the user.
setRows in interface IAutoCompleteEntrypublic int getRows()
Return the value of the rows property.
Contents: The maximum number of possible options to show to the user. Default = '10'.
getRows in interface IAutoCompleteEntrypublic void setShowEffect(java.lang.String showEffect)
Set the value of the showEffect property.
Contents: Effect to use when showing the list. Possible values are 'blind', 'bounce', 'clip', 'drop', 'explode', 'fade', 'fold', 'puff', 'pulsate', 'scale', 'slide', and 'shake'.
setShowEffect in interface IAutoCompleteEntrypublic java.lang.String getShowEffect()
Return the value of the showEffect property.
Contents: Effect to use when showing the list. Possible values are 'blind', 'bounce', 'clip', 'drop', 'explode', 'fade', 'fold', 'puff', 'pulsate', 'scale', 'slide', and 'shake'. Default = 'fade'.
getShowEffect in interface IAutoCompleteEntrypublic void setShowEffectLength(int showEffectLength)
Set the value of the showEffectLength property.
Contents: Length of time in milliseconds the show effect will last for.
setShowEffectLength in interface IAutoCompleteEntrypublic int getShowEffectLength()
Return the value of the showEffectLength property.
Contents: Length of time in milliseconds the show effect will last for. Default = '150'.
getShowEffectLength in interface IAutoCompleteEntrypublic void setTextChangeListener(javax.el.MethodExpression textChangeListener)
Set the value of the textChangeListener property.
Contents: MethodExpression representing a text change listener method that will be notified when the text of the input field changes after the user types new characters or removes them. This is different from a value change event in that in this case the user has not yet given a definite input and is just typing strings to to obtain lists of possible values. The value change event differs in that it only fires once the user has selected a value from the list or has pressed 'enter' on the input field. The expression must evaluate to a public method that takes a org.icefaces.ace.event.TextChageEvent parameter, with a return type of void.
setTextChangeListener in interface IAutoCompleteEntrypublic javax.el.MethodExpression getTextChangeListener()
Return the value of the textChangeListener property.
Contents: MethodExpression representing a text change listener method that will be notified when the text of the input field changes after the user types new characters or removes them. This is different from a value change event in that in this case the user has not yet given a definite input and is just typing strings to to obtain lists of possible values. The value change event differs in that it only fires once the user has selected a value from the list or has pressed 'enter' on the input field. The expression must evaluate to a public method that takes a org.icefaces.ace.event.TextChageEvent parameter, with a return type of void.
getTextChangeListener in interface IAutoCompleteEntrypublic void setWidth(int width)
Set the value of the width property.
Contents: The width of the text input field, in pixels.
setWidth in interface IAutoCompleteEntrypublic int getWidth()
Return the value of the width property.
Contents: The width of the text input field, in pixels. Default = '150'.
getWidth in interface IAutoCompleteEntrypublic void setItemList(java.util.List itemList)
Set the value of the itemList property.
setItemList in interface IAutoCompleteEntrypublic java.util.List getItemList()
Return the value of the itemList property.
getItemList in interface IAutoCompleteEntrypublic void setPopulateList(java.lang.Boolean populateList)
Set the value of the populateList property.
setPopulateList in interface IAutoCompleteEntrypublic java.lang.Boolean isPopulateList()
Return the value of the populateList property.
isPopulateList in interface IAutoCompleteEntrypublic void setSubmittedText(java.lang.String submittedText)
Set the value of the submittedText property.
setSubmittedText in interface IAutoCompleteEntrypublic java.lang.String getSubmittedText()
Return the value of the submittedText property.
getSubmittedText in interface IAutoCompleteEntrypublic void setText(java.lang.String text)
Set the value of the text property.
setText in interface IAutoCompleteEntrypublic java.lang.String getText()
Return the value of the text property.
getText in interface IAutoCompleteEntryprotected boolean isPropertySet(java.lang.String finder)
public void setValueExpression(java.lang.String name,
javax.el.ValueExpression binding)
setValueExpression in class javax.faces.component.UIComponentpublic java.util.Collection<java.lang.String> getEventNames()
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHoldergetEventNames in class javax.faces.component.html.HtmlInputTextpublic java.lang.String getDefaultEventName()
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHoldergetDefaultEventName in class javax.faces.component.html.HtmlInputTextpublic java.lang.String getDefaultRender(java.lang.String event)
getDefaultRender in interface IceClientBehaviorHolderpublic java.lang.String getDefaultExecute(java.lang.String event)
getDefaultExecute in interface IceClientBehaviorHolderpublic java.lang.String getListenerArgument(java.lang.String event)
getListenerArgument in interface IceClientBehaviorHolderpublic void addClientBehavior(java.lang.String eventName,
javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolderaddClientBehavior in class javax.faces.component.UIComponentBaseCopyright 2017 ICEsoft Technologies Canada Corp., All Rights Reserved.