|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.faces.component.UIComponent javax.faces.component.UIComponentBase com.ibm.xsp.component.UITypeAhead
public class UITypeAhead
Abstract AJAX type ahead control for an existing input text.
This abstract control takes care of processing the values to be returned to the client based on the values entered by the user. The concrete control that extends this is the ajaxTypeAhead control.
Not intended to be subclassed.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class javax.faces.component.UIComponentBase |
---|
javax.faces.component.UIComponentBase.AggregatedIterator, javax.faces.component.UIComponentBase.UnmodifiableIterator |
Nested classes/interfaces inherited from class javax.faces.component.UIComponent |
---|
javax.faces.component.UIComponent.StateMap, javax.faces.component.UIComponent.StateMapEntry |
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_FAMILY
|
static java.lang.String |
COMPONENT_TYPE
|
static java.lang.String |
PARENT_RENDERER_TYPE
|
static java.lang.String |
RENDERER_TYPE
|
static java.lang.String |
VALUE_NAME
The name of the request parameter containing the value typed in so far in the typeAhead, available when processing an ajax request from the client-side typeAhead. |
Fields inherited from class javax.faces.component.UIComponentBase |
---|
EMPTY_ITERATOR |
Fields inherited from class javax.faces.component.UIComponent |
---|
_xspStateId |
Constructor Summary | |
---|---|
UITypeAhead()
|
Method Summary | |
---|---|
void |
addDojoAttribute(DojoAttribute attribute)
Add a dojo attribute to the set associated with this property. |
void |
encodeBegin(javax.faces.context.FacesContext context)
|
void |
encodeChildren(javax.faces.context.FacesContext context)
|
void |
encodeEnd(javax.faces.context.FacesContext context)
|
java.lang.String |
getDefaultHtmlFilter()
|
java.util.List<DojoAttribute> |
getDojoAttributes()
Return the value of the dojoAttributes property. |
java.lang.String |
getDojoType()
Return the value of the dojoType property. |
java.lang.String |
getFamily()
|
java.lang.String |
getHtmlFilter()
Return the value of the htmlFilter property. |
java.lang.String |
getHtmlFilterName()
Look for an html filtering engine associated to the control. |
int |
getMaxValues()
Return the value of the maxValues property. |
java.lang.String |
getParentRendererType()
|
java.lang.Object |
getValueList()
Return the value of the valueList property. |
java.lang.String |
getValueListSeparator()
Return the value of the valueListSeparator property. |
java.lang.String |
getVar()
Returns the var value used by children to reference the data associated with this component. |
boolean |
handles(javax.faces.context.FacesContext context)
Check if the pathinfo request is for this target ajax component |
protected boolean |
isChangeParentRenderer()
Available to override in subclasses, used to determine whether to change the parent control's renderer-type. |
boolean |
isIgnoreCase()
Return the value of the ignoreCase property. |
boolean |
isPreventFiltering()
Return the value of the preventFiltering property. |
boolean |
isReadonly()
|
boolean |
isTypeAheadEnabled(javax.faces.context.FacesContext context)
|
boolean |
isValueMarkup()
Return the value of the valueMarkup property. |
protected boolean |
match(java.lang.String value,
java.lang.String starts,
boolean ignoreCase)
Helper method which indicates if the value matches that of the starts value, optionally ignoring case. |
void |
processAjaxRequest(javax.faces.context.FacesContext context)
Process the request for this target ajax component |
void |
restoreState(javax.faces.context.FacesContext context,
java.lang.Object state)
|
java.lang.Object |
saveState(javax.faces.context.FacesContext context)
|
void |
setDojoAttributes(java.util.List<DojoAttribute> dojoAttributes)
Set the value of the dojoAttributes property. |
void |
setDojoType(java.lang.String dojoType)
Set the value of the dojoType property. |
void |
setHtmlFilter(java.lang.String htmlFilter)
Set the value of the htmlFilter property. |
void |
setIgnoreCase(boolean ignoreCase)
Set the value of the ignoreCase property. |
void |
setMaxValues(int maxValues)
Set the value of the maxValues property. |
void |
setParent(javax.faces.component.UIComponent parent)
|
void |
setParentRendererType(java.lang.String parentRendererType)
|
void |
setPreventFiltering(boolean preventFiltering)
Set the value of the ignoreCase property. |
void |
setValueList(java.lang.Object valueList)
Set the value of the valueList property. |
void |
setValueListSeparator(java.lang.String valueListSeparator)
Set the value of the valueListSeparator property. |
void |
setValueMarkup(boolean valueMarkup)
Set the value of the valueMarkup property. |
void |
setVar(java.lang.String var)
Returns the var value. |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
_xspCleanTransientData, _xspGetReadOnlyObj, _xspGetRendererData, _xspRemoveReadOnlyObj, _xspRemoveRendererData, _xspSetIdUnchecked, _xspSetReadOnlyObj, _xspSetRendererData, addFacesListener, broadcast, decode, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setRendered, setRendererType, setTransient, setValueBinding |
Methods inherited from class javax.faces.component.UIComponent |
---|
_xspGetStateId, _xspGetStateMap, _xspRestoreAttribute, _xspRestoreState, _xspSaveState, invokeOnComponent, isVisitable, markInitialState, setControlState, visitTree |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String RENDERER_TYPE
public static final java.lang.String PARENT_RENDERER_TYPE
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String VALUE_NAME
Constructor Detail |
---|
public UITypeAhead()
Method Detail |
---|
public void setParent(javax.faces.component.UIComponent parent)
setParent
in class javax.faces.component.UIComponentBase
protected boolean isChangeParentRenderer()
public java.lang.String getDefaultHtmlFilter()
public java.lang.String getHtmlFilterName()
FacesOutputFiltering
getHtmlFilterName
in interface FacesOutputFiltering
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIComponent
public java.lang.String getVar()
public void setVar(java.lang.String var)
var
- the var to setpublic int getMaxValues()
Return the value of the maxValues
property. Contents:
Indicates the maximum number of selections to display in the drop down list
public java.lang.Object getValueList()
Return the value of the valueList
property. Contents:
The list of values returned to the client. In case of markup, then it should return a n HTML list (see bellow). Else, it assumes a list of string values which can be one of: a) Java array/collection toString() is applied to each entry in order to compose the result. b) A string value It splits the string using a separator (valueListSeparator). c) A javascript value (FBSScript) Treat it as either a string or a collection.
public java.lang.String getValueListSeparator()
Return the value of the valueListSeparator
property.
Contents:
The separator to use in case of strings.
public boolean isIgnoreCase()
Return the value of the ignoreCase
property. Contents:
Indicate if the search should ignore the character case.
public boolean isPreventFiltering()
Return the value of the preventFiltering
property.
Indicate if the list of values should be filtered with the value sent by the browser.
public boolean isValueMarkup()
Return the value of the valueMarkup
property. Contents:
Indicate if value list contains a whole XML markup fragment or simply a list.
protected boolean match(java.lang.String value, java.lang.String starts, boolean ignoreCase)
value
matches that of the starts
value, optionally ignoring case.
value
- starts
- ignoreCase
-
public boolean handles(javax.faces.context.FacesContext context)
FacesAjaxComponent
handles
in interface FacesAjaxComponent
public void processAjaxRequest(javax.faces.context.FacesContext context) throws java.io.IOException
FacesAjaxComponent
processAjaxRequest
in interface FacesAjaxComponent
java.io.IOException
public void setIgnoreCase(boolean ignoreCase)
Set the value of the ignoreCase
property.
public void setPreventFiltering(boolean preventFiltering)
Set the value of the ignoreCase
property.
public void setMaxValues(int maxValues)
Set the value of the maxValues
property.
public void setValueList(java.lang.Object valueList)
Set the value of the valueList
property.
public void setValueListSeparator(java.lang.String valueListSeparator)
Set the value of the valueListSeparator
property.
public void setValueMarkup(boolean valueMarkup)
Set the value of the valueMarkup
property.
public java.lang.String getHtmlFilter()
Return the value of the htmlFilter
property. Contents:
Property indicating which Active Content Filtering processor should be used when data is emitted.
public void setHtmlFilter(java.lang.String htmlFilter)
Set the value of the htmlFilter
property.
public java.lang.String getDojoType()
Return the value of the dojoType
property. Contents:
Sets the default Dojo Type used to create this control in the browser.
getDojoType
in interface FacesDojoComponent
public void setDojoType(java.lang.String dojoType)
Set the value of the dojoType
property.
public java.util.List<DojoAttribute> getDojoAttributes()
Return the value of the dojoAttributes
property. Contents:
A list of Dojo attributes
getDojoAttributes
in interface FacesDojoComponent
public void addDojoAttribute(DojoAttribute attribute)
action
- public void setDojoAttributes(java.util.List<DojoAttribute> dojoAttributes)
Set the value of the dojoAttributes
property.
public void encodeBegin(javax.faces.context.FacesContext context) throws java.io.IOException
encodeBegin
in class javax.faces.component.UIComponentBase
java.io.IOException
public void encodeChildren(javax.faces.context.FacesContext context) throws java.io.IOException
encodeChildren
in class javax.faces.component.UIComponentBase
java.io.IOException
public void encodeEnd(javax.faces.context.FacesContext context) throws java.io.IOException
encodeEnd
in class javax.faces.component.UIComponentBase
java.io.IOException
public void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.UIComponentBase
public java.lang.Object saveState(javax.faces.context.FacesContext context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UIComponentBase
public java.lang.String getParentRendererType()
public void setParentRendererType(java.lang.String parentRendererType)
parentRendererType
- the parentRendererType to setpublic boolean isTypeAheadEnabled(javax.faces.context.FacesContext context)
public boolean isReadonly()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |