|
ICEfaces ACE Components 3.3.0 Java API Documentation |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIOutput
javax.faces.component.UIInput
javax.faces.component.html.HtmlInputText
org.icefaces.ace.component.autocompleteentry.AutoCompleteEntryBase
public class AutoCompleteEntryBase
AutoCompleteEntry is a text input component that presents possible valid options as the user types. The options can be a list of SelectItem's specified in a child
For more information, see the AutoCompleteEntry Wiki Documentation.
Nested Class Summary | |
---|---|
protected static class |
AutoCompleteEntryBase.PropertyKeys
|
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_TYPE
|
static java.lang.String |
RENDERER_TYPE
|
Fields inherited from class javax.faces.component.UIInput |
---|
COMPONENT_FAMILY, CONVERSION_MESSAGE_ID, 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 |
Constructor Summary | |
---|---|
AutoCompleteEntryBase()
|
Method Summary | |
---|---|
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.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 |
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 |
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. |
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 |
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 |
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 |
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 |
setWidth(int width)
Set the value of the width property. |
Methods inherited from class javax.faces.component.html.HtmlInputText |
---|
getAccesskey, getAlt, getAutocomplete, getDir, getLabel, 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, setAutocomplete, setDir, setDisabled, setLabel, 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, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, 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 |
Methods inherited from class javax.faces.component.UIOutput |
---|
getConverter, getLocalValue, getValue, setConverter |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addFacesListener, broadcast, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, 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, 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 |
---|
getClientBehaviors |
Methods inherited from interface javax.faces.component.ValueHolder |
---|
getConverter, getLocalValue, getValue, setConverter |
Field Detail |
---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String RENDERER_TYPE
Constructor Detail |
---|
public AutoCompleteEntryBase()
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIInput
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 = '400'.
getDelay
in interface IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public 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 IAutoCompleteEntry
public void setWidth(int width)
Set the value of the width
property.
Contents: The width of the text input field, in pixels.
setWidth
in interface IAutoCompleteEntry
public int getWidth()
Return the value of the width
property.
Contents: The width of the text input field, in pixels. Default = '150'.
getWidth
in interface IAutoCompleteEntry
public void setItemList(java.util.List itemList)
Set the value of the itemList
property.
setItemList
in interface IAutoCompleteEntry
public java.util.List getItemList()
Return the value of the itemList
property.
getItemList
in interface IAutoCompleteEntry
public void setPopulateList(java.lang.Boolean populateList)
Set the value of the populateList
property.
setPopulateList
in interface IAutoCompleteEntry
public java.lang.Boolean isPopulateList()
Return the value of the populateList
property.
isPopulateList
in interface IAutoCompleteEntry
public void setText(java.lang.String text)
Set the value of the text
property.
setText
in interface IAutoCompleteEntry
public java.lang.String getText()
Return the value of the text
property.
getText
in interface IAutoCompleteEntry
public java.util.Collection<java.lang.String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
getEventNames
in class javax.faces.component.html.HtmlInputText
public java.lang.String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class javax.faces.component.html.HtmlInputText
public java.lang.String getDefaultRender(java.lang.String event)
getDefaultRender
in interface IceClientBehaviorHolder
public java.lang.String getDefaultExecute(java.lang.String event)
getDefaultExecute
in interface IceClientBehaviorHolder
public void addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class javax.faces.component.UIComponentBase
|
ICEfaces ACE Components 3.3.0 Java API Documentation |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |