Plain text
Allows users to enter plain text. You can display placeholder text to guide your users.
Appearance
Width: | The width of the text box in px, %, em\r\nFor example\: 50px, 20%, 4em. If no unit is specified, px is assumed | String |
Size: | The size of the view. {Default | Large | Small} |
TextSizeStyle |
Label placement: | The label position. {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 |
Show overflow text in tooltip: | Show the full text in a tooltip when the content overflows the view boundaries. | Boolean |
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: | The text that is displayed when no text is entered. | String |
Regular expression: | The regular expression used to validate text entries. | String |
Select text on focus: | Selects all the text in the view when a user clicks the text box. | Boolean |
Formula
Text expression: | The formula or expression to calculate the text. | String |
Events | |||||||||||
On Load: |
| ||||||||||
On Change: |
| ||||||||||
On Focus: |
| ||||||||||
On Blur: |
| ||||||||||
On Input: |
|
Extends:
Methods:
Inherited
addClass(name, [replaced])
Add/replace CSS class(es) for this control
Name | Type | Default | Description |
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 for button
getLabel()
Returns:
{string}
Gets the label associated with the control
getLabelPlacement()
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 text control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
getPlaceholder()
Returns:
{string}
Get placeholder text associated with the control
getSizeStyle()
Gets size style of text control
getTabIndex()
Returns:
{integer}
Gets tab index for the control
getText()
Returns:
{string}
Gets text for the control
getType()
Returns:
{string}
Get descriptive string representing the type of control
getValidationExpression()
Returns:
{string}
Get validation (regular) expression for the control
getWidth()
Returns:
{string}
Gets configured width for the control (including unit)
Inherited
hide(collapseFlag)
Hide this view/control
Name | Type | Default | Description |
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}
Gets label visibility for the control
isSelectAll()
Returns:
{boolean}
Get whether or not all text is selected on focus
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
Name | Type | Default | Description |
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,
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
Name | Type | Default | Description |
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(text)
Set help text for button
Name | Type | Default | Description |
text | {string} | Rollover text to be set |
setLabel(label)
Sets the label for the control
Name | Type | Default | Description |
label | {string} | the label for the control |
setLabelPlacement(placement)
Set label placement for control. NOTE: to avoid ambiguity always set the label placement using "T"|"L"
Name | Type | Default | Description |
placement | {string} | "T"|"TOP"=Top | "L"|"LEFT"=Left |
Example
me.setLabelPlacement("L") |
setLabelVisible(flag)
Sets label visibility for the control
Name | Type | Default | Description |
flag | {boolean} | set visibility |
setLabelWidth(labelWidth)
Set label width of text control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name | Type | Default | Description |
labelWidth | {string} | Control's label width |
setPlaceholder(text)
Set placeholder text for the control
Name | Type | Default | Description |
text | {string} | sets placeholder text |
setSelectAll(flag)
Set whether or not all text should be selected on focus
Name | Type | Default | Description |
flag | {boolean} | Flag to set |
setSizeStyle(style)
Sets size style of control. NOTE: to avoid ambiguity always set the size style using "D"|"S"|"L"
Name | Type | Default | Description |
style | {string} | "DEFAULT"|"DEF"|"NORMAL"|"D"=Default | "SMALL"|"S"=Small | "LARGE"|"L"=Large |
setTabIndex(tabIndex)
Sets tab index of the control
Name | Type | Default | Description |
tabIndex | {integer} | tab indices start at 1 and may be set sparsely |
setText(text)
Sets text for the control
Name | Type | Default | Description |
text | {string} | to be set in the control |
Inherited
setValid(valid, errorText)
Flag this view/control as valid or invalid
Name | Type | Default | Description |
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 |
setValidationExpression(re)
Set validation (regular) expression of the control
Name | Type | Default | Description |
re | {string} | regular expression |
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
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 OptionsName | Type | Default | Description |
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
Name | Type | Default | Description |
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)
Sets width of the control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name | Type | Default | Description |
width | {string} | sets the width of the control |
Inherited
show()
Show this view/control
Example
MyView.show(); |
Inherited
triggerFormulaUpdates([phase])
Broadcasts the expression trigger for the specified view
Name | Type | Default | Description |
phase | {int} | bpmext.ui.PHASE_NORMAL | The phase we are currently in |
Example
MyView.triggerFormulaUpdates(); |