Class: TextEditor

TextEditor

The Text Editor control allows users to enter text information into an editor box that comes with many easy to configure appearance and behavior options. A TextEditor control provides the following configuration properties in Process Designer:

Appearance

Width: Width in px, %, em For example: 50px, 20%, 0.4em. If no unit is specified, px is assumed string
Height: Height in px, %, em For example: 50px, 20%, 0.4em. If no unit is specified, px is assumed string

Behavior

Tab Index: Form control tabbing sequence index. Tab indices start at 1, and may be set sparsely. 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: Number of columns default text color palette should contain. Default is 8 integer
Palette Rows: Number of rows default text color palette should contain. 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:
Description: Triggers whenever the view is loaded.
Example:
me.focus()
On Change:
Description: Triggers when the data bound to this control changes.
Example:
me.setValid(me.getText(), "Input is required")
Context Variables newText {string} oldText {string}
On Focus:
Description: Triggers when the view gains focus.
Example:
me.setHeight("500px")
On Blur:
Description: Triggers when teh view loses focus.
Example:
me.setHeight("150px")
Article(s)
Text Editor

new TextEditor()

This constructor is never used explicitly.

Extends

Members

Methods

Add/replace CSS class(es) for this control
Name Type 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 optional 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");
Set focus on this control
Retrieve bound data associated this view/control. Only works for views/controls with bound data.
Returns:
Type Description
Object Value of bound data. undefined if the view has no data binding.
Example
var dec1 = MyDecimal.getData();

getHeight(){string}

Get configured height for text editor control (including unit)
Returns:
Type Description
string

getLabel(){string}

Get label associated with text editor control
Returns:
Type Description
string

getStatusBarVisibility(){boolean}

Get the current visibility of the status bar
Returns:
Type Description
boolean

getTabIndex(){integer}

Get tab index for text editor control
Returns:
Type Description
integer

getText(){string}

Get text for text editor control
Returns:
Type Description
string

getType(){string}

Get descriptive string representing the type of control
Returns:
Type Description
string

getWidth(){string}

Get configured width for text editor control (including unit)
Returns:
Type Description
string
Hide this view/control
Name Type Description
collapseFlag boolean Set to true to collapse the view (equivalent to a view setting of "NONE")
Example
MyView.hide();
Indicates bound status of control.
Returns:
Type Description
boolean True if the control is bound to coach data.
Checks if the view is enabled or not
Returns:
Type Description
boolean Enabled status
Example
var enabled = MyView.isEnabled();

isLabelVisible(){boolean}

Get label visibility for text editor control
Returns:
Type Description
boolean
Returns the valid status as last set by the setValid() method.
Returns:
Type Description
boolean Validity status. true if setValid(false, ...) was never called
Example
var valid = MyView.isValid();
Checks whether or not view is visible
Returns:
Type Description
boolean Visibility status
Example
var visible = MyView.isVisible();
Propagates value change of control up through parent views
Name Type Description
event Event Value change event (usually an onchange event)
Returns:
Type Description
boolean True if a formula update was triggered on the control's parent, otherwise false
Example
MyView.propagateUp(event);
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
Set/update bound data associated this view/control. Only works for views/controls with bound data.
Name Type Description
value Object Value of bound data. The type of this parameter must match the type of the bound data.
Example
MyView.setData("TEST"); //Updates bound data to the string 'TEST'
Enable/disable this view/control
Name Type 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 Description
height string Editor height

setLabel(label)

Set label for text editor control
Name Type Description
label string Label for the text editor

setLabelVisible(flag)

Set label visibility for text editor control
Name Type Description
flag boolean Set to true to make the label visible.

setStatusBarVisibility(vis)

Sets tab index of text editor control
Name Type Description
vis boolean Set to true to show status bar

setTabIndex(tabIndex)

Sets tab index of text editor control
Name Type Description
tabIndex integer Tab indices start at 1 and may be set sparsely

setText(text)

Set text for text editor control
Name Type Description
text string Text to be set in the editor
Flag this view/control as valid or invalid
Name Type 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
Show/hide this view/control
Name Type 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 Description
width string editor width
Show this view/control
Example
MyView.show();
Broadcasts the expression trigger for the specified view
Name Type Default Description
phase int bpmext.ui.PHASE_NORMAL optional The phase we are currently in
Example
MyView.triggerFormulaUpdates();