Controls Documentation

Controls  Complex Types  Show Hierarchies  Show Full Hierarchies 

Control: xp:typeAhead

f:javax.faces.Component
   xp:com.ibm.xsp.UITypeAhead
      xp:typeAhead

Description

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

Properties

Java

Java Class: com.ibm.xsp.component.xp.XspTypeAhead


basics

binding, object - javax.faces.component.UIComponent  [Inherited]
Control Binding
Specifies an expression that binds the control to a particular control property.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding false
loaded, boolean  [Inherited]
Loaded
Specifies whether or not the control should be created when the page is loaded. Value defaults to 'true'.
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
id, string  [Inherited]
Control Identifier
Specifies the name identifier for the control. No two controls can have the same name identifier in a single page.
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
rendered, boolean  [Inherited]
Rendered Flag
Indicates whether or not the control should be displayed or processed on any subsequent form submission.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
rendererType, string  [Inherited]
Renderer Type
Identifies (with the "family" defined by the control) an appropriate renderer to encode and decode this control
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
htmlFilter, string  [Inherited]
HTML Filtering processor name
Indicates which Active Content Filtering processor to use.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
maxValues, int  [Inherited]
Maximum Values
Indicates the maximum number of selections to display in the drop down list
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
ignoreCase, boolean  [Inherited]
Ignore Case
Indicate if the search should ignore the character case
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
preventFiltering, boolean  [Inherited]
Prevent Filtering
Prevents the control from filtering the list of values using the value submitted by the browser. This is supposed to be done by a ValueBinding expression for the valueList property. When this property is false (default behavior), then only the values in the list starting with the characters submitted by the browser are returned.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
dojoUsage, string
Dojo Usage
This property is obsolete, configure the "Dojo Type" property instead. This used to determine whether the control would use Dojo.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
dojoStoreType, string
Dojo Store Type
Overrides the default Dojo Type used to create the data store for this control.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
url, string
URL
Specifies the URL for the external resource. Only valid with mode="external".
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
mode, string
Mode
AJAX request mode. It can be one of 'external', 'partial', 'full' or 'none'.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
inputId, string
Input ID
Obsolete: The parent input control is always used, it is not configurable using this property.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
minChars, int
Minimum Characters
The minimum number of characters in the input field that triggers the search, (defaults to 1).
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
frequency, double
Frequency
The minimum time in seconds to wait before triggering the server request.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
tokens, string
Tokens
A character or character array that specifies the separator(s) on the client side, in case of multiple values.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

data

var, string  [Inherited]
Variable
Request scope variable name for the current value being used by the typeahead control
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
valueList, generic  [Inherited]
Value List
The list of values returned to the client. In case of markup, then it should return a HTML list. Else, it assumes a list of string values which can be one of: a) Java array or 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.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
valueListSeparator, string  [Inherited]
Value List Separator
The separator to use when the Value List is a string, defaulting to new line.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
valueMarkup, boolean  [Inherited]
Value Markup
Indicate if value list contains a whole XML markup fragment or simply a list
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

dojo

dojoType, string  [Inherited]
Dojo Type
Sets the default Dojo Type used to create this control in the browser.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
dojoAttributes, Collection of xp:dojoAttribute - com.ibm.xsp.dojo.DojoAttribute  [Inherited]
Dojo Attributes
Specifies a list of Dojo attributes.
Required Attribute false

events

onStart, string
On Start Event
Specifies the JavaScript executed before a request.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onComplete, string
On Complete Event
The JavaScript executed after a request.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
onError, string
On Error Event
Specifies the JavaScript executed in case of an error.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

styling

disableTheme, boolean  [Inherited]
Disable Theme
A flag used to determine if the theme should be applied to this control.
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
themeId, string  [Inherited]
Theme Id
The theme id that should be used to set the component properties when a theme is applied
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true