com.ibm.xsp.component.xp
Class XspTypeAhead

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          com.ibm.xsp.component.UITypeAhead
              com.ibm.xsp.component.xp.XspTypeAhead

All Implemented Interfaces:

FacesAjaxComponent, FacesOutputFiltering, FacesDojoComponent, javax.faces.component.StateHolder

public class XspTypeAhead
extends UITypeAhead

An input control that automatically fills itself in as users type a succession of characters that match a specified suggestion.

XPages Other Controls - AJAX Type Ahead

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_TYPE

Fields inherited from class com.ibm.xsp.component.UITypeAhead

COMPONENT_FAMILY, PARENT_RENDERER_TYPE, RENDERER_TYPE, VALUE_NAME

Fields inherited from class javax.faces.component.UIComponentBase

EMPTY_ITERATOR

Fields inherited from class javax.faces.component.UIComponent

_xspStateId

Constructor Summary

XspTypeAhead()

Method Summary

java.lang.String	getDojoStoreType() Return the value of the dojoStoreType property.
java.lang.String	getDojoUsage() Return the value of the dojoUsage property.
double	getFrequency() Return the value of the frequency property.
java.lang.String	getInputId() Return the value of the inputId property.
int	getMinChars() Return the value of the minChars property.
java.lang.String	getMode() Return the value of the mode property.
java.lang.String	getOnComplete() Return the value of the onComplete property.
java.lang.String	getOnError() Return the value of the onError property.
java.lang.String	getOnStart() Return the value of the onStart property.
java.lang.String	getTokens() Return the value of the tokens property.
java.lang.String	getUrl() Return the value of the url property.
void	restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
java.lang.Object	saveState(javax.faces.context.FacesContext _context)
void	setDojoStoreType(java.lang.String dojoStoreType) Set the value of the dojoStoreType property.
void	setDojoUsage(java.lang.String dojoUsage) Set the value of the dojoUsage property.
void	setFrequency(double frequency) Set the value of the frequency property.
void	setInputId(java.lang.String inputId) Set the value of the inputId property.
void	setMinChars(int minChars) Set the value of the minChars property.
void	setMode(java.lang.String mode) Set the value of the mode property.
void	setOnComplete(java.lang.String onComplete) Set the value of the onComplete property.
void	setOnError(java.lang.String onError) Set the value of the onError property.
void	setOnStart(java.lang.String onStart) Set the value of the onStart property.
void	setTokens(java.lang.String tokens) Set the value of the tokens property.
void	setUrl(java.lang.String url) Set the value of the url property.

Methods inherited from class com.ibm.xsp.component.UITypeAhead

addDojoAttribute, encodeBegin, encodeChildren, encodeEnd, getDefaultHtmlFilter, getDojoAttributes, getDojoType, getFamily, getHtmlFilter, getHtmlFilterName, getMaxValues, getParentRendererType, getValueList, getValueListSeparator, getVar, handles, isChangeParentRenderer, isIgnoreCase, isPreventFiltering, isReadonly, isTypeAheadEnabled, isValueMarkup, match, processAjaxRequest, setDojoAttributes, setDojoType, setHtmlFilter, setIgnoreCase, setMaxValues, setParent, setParentRendererType, setPreventFiltering, setValueList, setValueListSeparator, setValueMarkup, setVar

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

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

XspTypeAhead

public XspTypeAhead()

Method Detail

getDojoStoreType

public java.lang.String getDojoStoreType()

Return the value of the dojoStoreType property. Contents:

Overrides the default Dojo Type used to create the data store for this control.

getDojoUsage

public java.lang.String getDojoUsage()

Return the value of the dojoUsage property. Contents:

This property is obsolete, configure the "Dojo Type" property instead. This used to determine whether the control would use Dojo.

XPages Basics Property Category - Dojo Usage

getFrequency

public double getFrequency()

Return the value of the frequency property. Contents:

The minimum time in seconds to wait before triggering the server request.

getInputId

public java.lang.String getInputId()

Return the value of the inputId property. Contents:

Obsolete: The parent input control is always used, it is not configurable using this property.

getMinChars

public int getMinChars()

Return the value of the minChars property. Contents:

The minimum number of characters in the input field that triggers the search, (defaults to 1).

getMode

public java.lang.String getMode()

Return the value of the mode property. Contents:

AJAX request mode. It can be one of 'external', 'partial', 'full' or 'none'.

getOnComplete

public java.lang.String getOnComplete()

Return the value of the onComplete property. Contents:

The JavaScript executed after a request.

getOnError

public java.lang.String getOnError()

Return the value of the onError property. Contents:

Specifies the JavaScript executed in case of an error.

getOnStart

public java.lang.String getOnStart()

Return the value of the onStart property. Contents:

Specifies the JavaScript executed before a request.

getTokens

public java.lang.String getTokens()

Return the value of the tokens property. Contents:

A character or character array that specifies the separator(s) on the client side, in case of multiple values.

getUrl

public java.lang.String getUrl()

Return the value of the url property. Contents:

Specifies the URL for the external resource. Only valid with mode="external".

restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class UITypeAhead

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class UITypeAhead

setDojoStoreType

public void setDojoStoreType(java.lang.String dojoStoreType)

Set the value of the dojoStoreType property.

setDojoUsage

public void setDojoUsage(java.lang.String dojoUsage)

Set the value of the dojoUsage property.

setFrequency

public void setFrequency(double frequency)

Set the value of the frequency property.

setInputId

public void setInputId(java.lang.String inputId)

Set the value of the inputId property.

setMinChars

public void setMinChars(int minChars)

Set the value of the minChars property.

setMode

public void setMode(java.lang.String mode)

Set the value of the mode property.

setOnComplete

public void setOnComplete(java.lang.String onComplete)

Set the value of the onComplete property.

setOnError

public void setOnError(java.lang.String onError)

Set the value of the onError property.

setOnStart

public void setOnStart(java.lang.String onStart)

Set the value of the onStart property.

setTokens

public void setTokens(java.lang.String tokens)

Set the value of the tokens property.

setUrl

public void setUrl(java.lang.String url)

Set the value of the url property.