Methods

addClass
focus
getData
getHelpText
getLabel
getLabelPlacementt
getLabelWidth
getPlaceholder
getSizeStyle
getTabIndex
getText
getType
getWidth
hide
isBound
isEnabled
isLabelVisible
isListItem
isValid
isVisible
propagateUpValueChange
recalculate
setEnabled
setHelpText
setLabel
setLabelPlacement
setLabelVisible
setLabelWidth
setPlaceholder
setSizeStyle
setTabIndex
setText
setValid
setViewData
setVisible
setWidth
show
triggerFormulaUpdates

Parent

CoachView

Helpers

bpmext.log
bpmext.number
bpmext.text
bpmext.ui
bpmext.ui.View
bpmext.ui.util
Type ahead text
Auto fills text based on the selection service that is attached to it, allowing for faster input.
Display items
Display items list: Display items to populate typeahead list. Will only be used if Item lookup mode is set to Items From List. String[]
Items
Item lookup mode: Method to use to populate typeahead list
{Start Empty | Items From Service | Items From List}		 TypeAheadItemsLookupMode
Type-ahead items service: Typeahead service. The service is called only if the Item lookup mode is set to Items From Service.
Items list: Items to populate typeahead list. Will only be used if Item lookup mode is set to Items From List. String[]
Appearance
Width: The width in px, % or em.\r\nFor example\: 50px, 20%, 0.4em. If no unit is specified, px is assumed. String
Size: The size of the view.
{Default | Large | Small}		 TextSizeStyle
Label placement: The position of the label. If you select Left, the width of the view changes.
{Top | Left}		 LabelPlacement
Label width: The width of the label in px, % or em.\r\nFor example\: 50px, 20%, 0.4em. If no unit is specified, px is assumed. String
Behavior
Tab index: The tabbing sequence index of the form view. Indices start at 1, and can be set sparsely. For example, you can use 1, 5, 10. Integer
Placeholder text: Placeholder text to display when no text has been entered. String
Number of drop-down items: The maximum number of drop-down items to display when the user starts typing. Integer
Events
On Load:
Description: Triggers whenever the view is loaded.
Example: 
me.setPlaceholder(${Data1}.getValue())
On Change:
Description: Triggers when the binding data changes.
Example: 
${Service1}.setInputData(me.getText());${Service1}.execute()
Context Variables newText {string} oldText {string}
Extends:
com.ibm.bpm.coach.CoachView
Methods:
Inherited addClass(name, [replaced])
Add/replace CSS class(es) for this control
NameTypeDefaultDescription
name{string}CSS class name(s) to add to the control. Separate class names by a space if more than one class.
replaced{string}CSS class name(s) to be replaced by the first argument. Separate class names by a space if more than one class.
Example
Button.addClass("green");
focus()
Set focus on this control
Inherited getData() Returns: {Object}
Retrieve bound data associated this view/control. Only works for views/controls with bound data.
Example
var dec1 = MyDecimal.getData();
getHelpText() Returns: {string}
Get help text associated with typeahead control
getLabel() Returns: {string}
Get label associated with the typeahead control
getLabelPlacementt() Returns: {string}
Get label placement for control. NOTE: This always returns the label placement as set, to avoid ambiguity always set the label placement using "T"|"L"
getLabelWidth() Returns: {string}
Get label width of type ahead text control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
getPlaceholder() Returns: {string}
Get placeholder text associated with the typeahead control
getSizeStyle() Returns: {string}
Gets size style of control. NOTE: This always returns the size style as set, to avoid ambiguity always set the size style using "D"|"S"|"L"
getTabIndex() Returns: {integer}
Get tab index for the typeahead control
getText() Returns: {string}
Get text for the typeahead control
getType() Returns: {string}
Get descriptive string representing the type of control
getWidth() Returns: {string}
Get configured width for the typeahead control (including unit)
Inherited hide(collapseFlag)
Hide this view/control
NameTypeDefaultDescription
collapseFlag{boolean}Set to true to collapse the view (equivalent to a view setting of "NONE")
Example
MyView.hide();
Inherited isBound() Returns: {boolean}
Indicates bound status of control.
Inherited isEnabled() Returns: {boolean}
Checks if the view is enabled or not
Example
var enabled = MyView.isEnabled();
isLabelVisible() Returns: {boolean}
Get label visibility for the typeahead control
isListItem(item) Returns: {boolean}
Boolean value indicating if parameter exists in the Type Ahead item list. NOTE: uses current value if no argument is provided.
NameTypeDefaultDescription
item{string}Potential list item
Inherited isValid() Returns: {boolean}
Returns the valid status as last set by the setValid() method.
Example
var valid = MyView.isValid();
Inherited isVisible() Returns: {boolean}
Checks whether or not view is visible
Example
var visible = MyView.isVisible();
Inherited propagateUpValueChange(event) Returns: {boolean}
Propagates value change of control up through parent views
NameTypeDefaultDescription
event{Event}Value change event (usually an onchange event)
Example
MyView.propagateUp(event);
Inherited recalculate()
Only for formula-enabled views!
Explicitly triggers the re-evaluation of the formula
for this view (if a formula has been specified). If the view is not formula-enabled, recalculate() does nothing.
Example
Text1.recalculate();
//If the formula for Text1 is: new Date().toString(), Text1 is updated to the current date/time
Inherited setEnabled(enabled, required)
Enable/disable this view/control
NameTypeDefaultDescription
enabled{boolean}Enabled/read-only flag (true to enable view, false to disable/make read-only)
required{boolean}Enable/disable required field flag for control
Example
MyView.setEnabled(false); //Make MyView read-only
setHelpText(helptext)
Set help text for typeahead control
NameTypeDefaultDescription
helptext{string}Help text for the control
setLabel(label)
Set label for the typeahead control
NameTypeDefaultDescription
label{string}Label to set
setLabelPlacement(placement)
Set label placement for control. NOTE: to avoid ambiguity always set the label placement using "T"|"L"
NameTypeDefaultDescription
placement{string}"T"|"TOP"=Top | "L"|"LEFT"=Left
setLabelVisible(flag)
Set label visibility for the typeahead control
NameTypeDefaultDescription
flag{boolean}{true | false}
setLabelWidth(labelWidth)
Set label width of type ahead text control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
NameTypeDefaultDescription
labelWidth{string}Control's label width
setPlaceholder(text)
Set placeholder text for the typeahead control
NameTypeDefaultDescription
text{string}Placeholder text
setSizeStyle(style)
Sets size style of control. NOTE: to avoid ambiguity always set the size style using "D"|"S"|"L"
NameTypeDefaultDescription
style{string}"DEFAULT"|"DEF"|"NORMAL"|"D"=Default | "SMALL"|"S"=Small | "LARGE"|"L"=Large
setTabIndex(tabIndex)
Sets tab index of the typeahead control
NameTypeDefaultDescription
tabIndex{integer}Tab indices start at 1 and may be set sparsely
setText(text)
Set text for the typeahead control
NameTypeDefaultDescription
text{string}Text to set in control
Inherited setValid(valid, errorText)
Flag this view/control as valid or invalid
NameTypeDefaultDescription
valid{boolean}Valid/invalid flag (true to set view valid, false to make it invalid - which typically shows the view with "invalid" styling and indicator)
errorText{string}Validation error text to show on the invalid-styled view
Example
MyView.setValid(false, "Please fix your data entry"); //Make MyView invalid
Inherited setViewData(data, createPseudoBinding)
Set/update bound data associated this view/control. Only works for views/controls with bound data.

Note: Should only be used with simple type bindings, or complex type bindings with simple type properties.
Should not be used with bindings that have properties that are lists or compext types. For complex types, set bindings using
the binding.set pattern detailed in the Knowlege Center section Binding Data and Configuration Options
NameTypeDefaultDescription
data{Object}Value of bound data. The type of this parameter must match the type of the bound data.
createPseudoBinding{boolean}If set to true, creates a pseudo binding if there is no current binding.
Example
MyView.setViewData("TEST"); //Updates bound data to the string 'TEST'
Inherited setVisible(visible, collapse)
Show/hide this view/control
NameTypeDefaultDescription
visible{boolean}Visibility flag (true to show view, false to hide)
collapse{boolean}Set to true to collapse the control space when visible is set to false.
Examples
MyView.setVisible(false, false); //Equivalent to MyView.hide()
MyView.setVisible(false, true); // Sets visibility to "None"
setWidth(width)
Set width of the typeahead control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
NameTypeDefaultDescription
width{string}Control width
Inherited show()
Show this view/control
Example
MyView.show();
Inherited triggerFormulaUpdates([phase])
Broadcasts the expression trigger for the specified view
NameTypeDefaultDescription
phase{int}bpmext.ui.PHASE_NORMALThe phase we are currently in
Example
MyView.triggerFormulaUpdates();