|
||||||||||
| 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
org.rcfaces.core.internal.component.CameliaInputComponent
org.rcfaces.core.component.AbstractInputComponent
org.rcfaces.core.component.TextEntryComponent
org.rcfaces.core.component.SuggestTextEntryComponent
public class SuggestTextEntryComponent
The suggestTextEntry is a textEntry Component with an autosuggestion feature that shows in the form of a dropdown list.
The suggestTextEntry Component has the following capabilities :
The default lineBreak renderer is linked to the f_suggestTextEntry javascript class. f_suggestTextEntry extends f_textEntry, fa_filterProperties, fa_commands
Table of component style classes:
| Style Name | Description |
|---|---|
| f_suggestTextEntry | Defines styles for the wrapper element |
| Field Summary | |
|---|---|
protected static Set |
CAMELIA_ATTRIBUTES
|
static String |
COMPONENT_TYPE
|
| Fields inherited from class org.rcfaces.core.component.TextEntryComponent |
|---|
CAMELIA_VALUE_ALIAS |
| Fields inherited from class org.rcfaces.core.internal.component.CameliaInputComponent |
|---|
engine |
| Fields inherited from class javax.faces.component.UIInput |
|---|
COMPONENT_FAMILY, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID |
| Fields inherited from class javax.faces.component.UIComponent |
|---|
bindings |
| Fields inherited from interface org.rcfaces.core.component.capability.ITextDirectionCapability |
|---|
DEFAULT_TEXT_DIRECTION, LEFT_TO_RIGHT_TEXT_DIRECTION, RIGHT_LEFT_TEXT_DIRECTION |
| Fields inherited from interface org.rcfaces.core.component.capability.IHiddenModeCapability |
|---|
CLIENT_HIDDEN_MODE, DEFAULT_HIDDEN_MODE, IGNORE_HIDDEN_MODE, PHANTOM_HIDDEN_MODE, SERVER_HIDDEN_MODE |
| Constructor Summary | |
|---|---|
SuggestTextEntryComponent()
|
|
SuggestTextEntryComponent(String componentId)
|
|
| Method Summary | |
|---|---|
void |
addMenuListener(IMenuListener listener)
Adds a listener to the component for the menu event |
void |
addSuggestionListener(ISuggestionListener listener)
Adds a listener to the component for the suggestion event |
protected Set |
getCameliaFields()
|
IFilterProperties |
getFilterProperties()
Return an object that represent the filter to use on the server side. |
IFilterProperties |
getFilterProperties(FacesContext facesContext)
See getFilterProperties() for more details |
int |
getMaxResultNumber()
Returns an int value specifying the maximum number of rows for the result. |
int |
getMaxResultNumber(FacesContext facesContext)
See getMaxResultNumber() for more details |
String |
getMoreResultsMessage()
|
String |
getMoreResultsMessage(FacesContext facesContext)
|
Converter |
getSuggestionConverter()
Returns a string specifying a converter id or a binding to a converter object. |
Converter |
getSuggestionConverter(FacesContext facesContext)
Returns a string specifying a converter id or a binding to a converter object. |
int |
getSuggestionDelayMs()
Returns an int value specifying the delay in milliseconds before showing the suggestion list. |
int |
getSuggestionDelayMs(FacesContext facesContext)
Returns an int value specifying the delay in milliseconds before showing the suggestion list. |
int |
getSuggestionMinChars()
Returns an int value specifying the minimum number of characters before the suggestion is calculated. |
int |
getSuggestionMinChars(FacesContext facesContext)
Returns an int value specifying the minimum number of characters before the suggestion is calculated. |
Object |
getSuggestionValue()
Returns a string value containing the value for the selected select item object. |
Object |
getSuggestionValue(FacesContext facesContext)
Returns a string value containing the value for the selected select item object. |
boolean |
isCaseSensitive()
Returns a boolean value indicating if the component should consider the case of the user input when using the data. |
boolean |
isCaseSensitive(FacesContext facesContext)
Returns a boolean value indicating if the component should consider the case of the user input when using the data. |
boolean |
isCaseSensitiveSetted()
Returns true if the attribute "caseSensitive" is set. |
boolean |
isFilterPropertiesSetted()
Returns true if the attribute "filterProperties" is set. |
boolean |
isForceProposal()
Returns a boolean value indicating if the first proposed value must be automatically appended to the current entry. |
boolean |
isForceProposal(FacesContext facesContext)
Returns a boolean value indicating if the first proposed value must be automatically appended to the current entry. |
boolean |
isForceProposalSetted()
Returns true if the attribute "forceProposal" is set. |
boolean |
isMaxResultNumberSetted()
Returns true if the attribute "maxResultNumber" is set. |
boolean |
isMoreResultsMessageSetted()
Returns true if the attribute "moreResultsMessage" is set. |
boolean |
isOrderedItems()
|
boolean |
isOrderedItems(FacesContext facesContext)
|
boolean |
isOrderedItemsSetted()
Returns true if the attribute "orderedItems" is set. |
boolean |
isSuggestionConverterSetted()
Returns true if the attribute "suggestionConverter" is set. |
boolean |
isSuggestionDelayMsSetted()
Returns true if the attribute "suggestionDelayMs" is set. |
boolean |
isSuggestionMinCharsSetted()
Returns true if the attribute "suggestionMinChars" is set. |
boolean |
isSuggestionValueSetted()
Returns true if the attribute "suggestionValue" is set. |
FacesListener[] |
listMenuListeners()
Returns a list of menu listener for the component |
FacesListener[] |
listSuggestionListeners()
Returns a list of suggestion listener for the component |
void |
removeMenuListener(IMenuListener listener)
Removes a listener from the component for the menu event |
void |
removeSuggestionListener(ISuggestionListener listener)
Removes a listener from the component for the suggestion event |
void |
setCaseSensitive(boolean caseSensitive)
Sets a boolean value indicating if the component should consider the case of the user input when using the data. |
void |
setFilterProperties(IFilterProperties filterProperties)
Sets an object that represent the filter to use on the server side. |
void |
setFilterProperties(String properties)
|
void |
setForceProposal(boolean forceProposal)
Sets a boolean value indicating if the first proposed value must be automatically appended to the current entry. |
void |
setMaxResultNumber(int maxResultNumber)
Sets an int value specifying the maximum number of rows for the result. |
void |
setMoreResultsMessage(String moreResultsMessage)
|
void |
setOrderedItems(boolean orderedItems)
|
void |
setSuggestionConverter(Converter suggestionConverter)
Sets a string specifying a converter id or a binding to a converter object. |
void |
setSuggestionConverter(String converterId)
|
void |
setSuggestionConverter(String converterId,
FacesContext facesContext)
|
void |
setSuggestionDelayMs(int suggestionDelayMs)
Sets an int value specifying the delay in milliseconds before showing the suggestion list. |
void |
setSuggestionMinChars(int suggestionMinChars)
Sets an int value specifying the minimum number of characters before the suggestion is calculated. |
void |
setSuggestionValue(Object suggestionValue)
Sets a string value containing the value for the selected select item object. |
| Methods inherited from class org.rcfaces.core.internal.component.CameliaInputComponent |
|---|
broadcast, clearListeners, confirmListenerAppend, constructPhase, constructTemplate, decodePhase, encodeBegin, encodeChildren, encodeEnd, getAsyncRenderer, getChildren, getChildrenListState, getConvertedValue, getFamily, getLocalValue, getRendererType, getSubmittedExternalValue, getTransientAttribute, getValue, getValueExpression, hasDefaultProperties, initializeComponent, initializePhase, isClientRendered, isRendered, isSubmittedValueSetted, isTemplateComponent, processDecodes, processEngineUpdates, processEngineValidators, processUpdates, processValidators, queueEvent, renderPhase, restoreState, saveState, setConverter, setConverter, setDefaultProperties, setRendered, setSubmittedExternalValue, setTransientAttribute, setValueExpression, toString, updatePhase, validationPhase, verifyAsyncDecode |
| Methods inherited from class javax.faces.component.UIInput |
|---|
addValidator, compareValues, decode, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, removeValidator, resetValue, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValue |
| Methods inherited from class javax.faces.component.UIOutput |
|---|
getConverter, setConverter |
| Methods inherited from class javax.faces.component.UIComponentBase |
|---|
addFacesListener, findComponent, getAttributes, getChildCount, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendersChildren, getValueBinding, invokeOnComponent, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding |
| Methods inherited from class javax.faces.component.UIComponent |
|---|
encodeAll, getContainerClientId |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.rcfaces.core.component.capability.IRequiredCapability |
|---|
isRequired, setRequired |
| Methods inherited from interface org.rcfaces.core.component.capability.IStyleClassCapability |
|---|
getStyleClass, setStyleClass |
| Methods inherited from interface org.rcfaces.core.component.capability.IImmediateCapability |
|---|
isImmediate, setImmediate |
| Methods inherited from interface org.rcfaces.core.internal.manager.IContainerManager |
|---|
getChildCount |
| Methods inherited from interface javax.faces.component.ValueHolder |
|---|
getConverter, setConverter, setValue |
| Field Detail |
|---|
public static final String COMPONENT_TYPE
protected static final Set CAMELIA_ATTRIBUTES
| Constructor Detail |
|---|
public SuggestTextEntryComponent()
public SuggestTextEntryComponent(String componentId)
| Method Detail |
|---|
public void setSuggestionConverter(String converterId)
public void setSuggestionConverter(String converterId,
FacesContext facesContext)
public void setFilterProperties(String properties)
public IFilterProperties getFilterProperties()
IFilterCapability
getFilterProperties in interface IFilterCapabilitypublic IFilterProperties getFilterProperties(FacesContext facesContext)
getFilterProperties() for more details
public final boolean isFilterPropertiesSetted()
true if the attribute "filterProperties" is set.
true if the attribute is set.public void setFilterProperties(IFilterProperties filterProperties)
IFilterCapability
setFilterProperties in interface IFilterCapabilityfilterProperties - filterpublic int getMaxResultNumber()
IMaxResultNumberCapability
getMaxResultNumber in interface IMaxResultNumberCapabilitypublic int getMaxResultNumber(FacesContext facesContext)
getMaxResultNumber() for more details
public final boolean isMaxResultNumberSetted()
true if the attribute "maxResultNumber" is set.
true if the attribute is set.public void setMaxResultNumber(int maxResultNumber)
IMaxResultNumberCapability
setMaxResultNumber in interface IMaxResultNumberCapabilitymaxResultNumber - max number of rowspublic final void addSuggestionListener(ISuggestionListener listener)
ISuggestionEventCapability
addSuggestionListener in interface ISuggestionEventCapabilitylistener - the suggestion listener to addpublic final void removeSuggestionListener(ISuggestionListener listener)
ISuggestionEventCapability
removeSuggestionListener in interface ISuggestionEventCapabilitylistener - the suggestion listener to removepublic final FacesListener[] listSuggestionListeners()
ISuggestionEventCapability
listSuggestionListeners in interface ISuggestionEventCapabilitypublic final void addMenuListener(IMenuListener listener)
IMenuEventCapability
addMenuListener in interface IMenuEventCapabilitylistener - the menu listener to addpublic final void removeMenuListener(IMenuListener listener)
IMenuEventCapability
removeMenuListener in interface IMenuEventCapabilitylistener - the menu listener to removepublic final FacesListener[] listMenuListeners()
IMenuEventCapability
listMenuListeners in interface IMenuEventCapabilitypublic int getSuggestionDelayMs()
public int getSuggestionDelayMs(FacesContext facesContext)
public void setSuggestionDelayMs(int suggestionDelayMs)
suggestionDelayMs - delay in millisecondspublic boolean isSuggestionDelayMsSetted()
true if the attribute "suggestionDelayMs" is set.
true if the attribute is set.public int getSuggestionMinChars()
public int getSuggestionMinChars(FacesContext facesContext)
public void setSuggestionMinChars(int suggestionMinChars)
suggestionMinChars - minimum number of characterspublic boolean isSuggestionMinCharsSetted()
true if the attribute "suggestionMinChars" is set.
true if the attribute is set.public boolean isCaseSensitive()
public boolean isCaseSensitive(FacesContext facesContext)
public void setCaseSensitive(boolean caseSensitive)
caseSensitive - true if case sensitivepublic boolean isCaseSensitiveSetted()
true if the attribute "caseSensitive" is set.
true if the attribute is set.public boolean isForceProposal()
public boolean isForceProposal(FacesContext facesContext)
public void setForceProposal(boolean forceProposal)
forceProposal - if proposal has to be forcedpublic boolean isForceProposalSetted()
true if the attribute "forceProposal" is set.
true if the attribute is set.public Object getSuggestionValue()
public Object getSuggestionValue(FacesContext facesContext)
public void setSuggestionValue(Object suggestionValue)
suggestionValue - value selectedpublic boolean isSuggestionValueSetted()
true if the attribute "suggestionValue" is set.
true if the attribute is set.public Converter getSuggestionConverter()
public Converter getSuggestionConverter(FacesContext facesContext)
public void setSuggestionConverter(Converter suggestionConverter)
suggestionConverter - converter idpublic boolean isSuggestionConverterSetted()
true if the attribute "suggestionConverter" is set.
true if the attribute is set.public String getMoreResultsMessage()
public String getMoreResultsMessage(FacesContext facesContext)
public void setMoreResultsMessage(String moreResultsMessage)
public boolean isMoreResultsMessageSetted()
true if the attribute "moreResultsMessage" is set.
true if the attribute is set.public boolean isOrderedItems()
public boolean isOrderedItems(FacesContext facesContext)
public void setOrderedItems(boolean orderedItems)
public boolean isOrderedItemsSetted()
true if the attribute "orderedItems" is set.
true if the attribute is set.protected Set getCameliaFields()
getCameliaFields in class TextEntryComponent
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||