Rich text
Allows users to configure the appearance and behavior of their text.
Appearance
Width: | The width in px, %, or em.\r\nFor example\: 50px, 20%, 0.4em. If no unit is specified, px is assumed. | String |
Height: | Height 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 |
Palette colors: | Default colors to populate text color palette with. Should be one less than the total number of spots in the palette (as determined by the number of rows and columns) in order to accomodate space for the option of removing colors. Name should represent the name of the color, and will be displayed as a tooltip when mousing over the color, while value should be the hexadecimal representation of the desired color. | NameValuePair[] |
Palette columns: | The number of columns in the default text color palette. The default is 8 | Integer |
Palette rows: | The number of rows in the default text color palette. The default is 5. | Integer |
Show status bar: | Shows the status bar underneath the editor area, which displays the current html element being edited | Boolean |
Events | |||||||||
On Load: |
| ||||||||
On Change: |
| ||||||||
On Focus: |
| ||||||||
On Blur: |
|
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(); |
getHeight()
Returns:
{string}
Get configured height for text editor control (including unit)
getHelpText()
Returns:
{string}
Get help text associated with the control
getLabel()
Returns:
{string}
Get label associated with text editor control
getStatusBarVisibility()
Returns:
{boolean}
Get the current visibility of the status bar
getTabIndex()
Returns:
{integer}
Get tab index for text editor control
getText()
Returns:
{string}
Get text for text editor control
getType()
Returns:
{string}
Get descriptive string representing the type of control
getWidth()
Returns:
{string}
Get configured width for text editor 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}
Get label visibility for text editor control
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 |
setHeight(height)
Set height of text editor control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name | Type | Default | Description |
height | {string} | Editor height |
setHelpText(helptext)
Set help text for the control
Name | Type | Default | Description |
helptext | {string} | Help text for the control |
setLabel(label)
Set label for text editor control
Name | Type | Default | Description |
label | {string} | Label for the text editor |
setLabelVisible(flag)
Set label visibility for text editor control
Name | Type | Default | Description |
flag | {boolean} | Set to true to make the label visible. |
setStatusBarVisibility(vis)
Sets tab index of text editor control
Name | Type | Default | Description |
vis | {boolean} | Set to true to show status bar |
setTabIndex(tabIndex)
Sets tab index of text editor control
Name | Type | Default | Description |
tabIndex | {integer} | Tab indices start at 1 and may be set sparsely |
setText(text)
Set text for text editor control
Name | Type | Default | Description |
text | {string} | Text to be set in the editor |
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 |
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)
Set width of text editor control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name | Type | Default | Description |
width | {string} | editor width |
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(); |