TextEditor

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:

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")

Extends:

com.ibm.bpm.coach.CoachView

Methods:

Inherited addClass(name, [replaced])

Add or replace the CSS classes for this view.

Name Type Default Description

name {string} The CSS class names to add to the view. For multiple classes, use space to separate the class names.

replaced {string} The CSS class names to be replaced by the first argument. For multiple classes, use space to separate the class names.

Example

Button.addClass("green");

focus()

Set focus on this control

Inherited getData() Returns: {Object}

Retrieve the bound data associated with the view. It applies only to views 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 the view.

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}

Indicate the bound status of the view.

Inherited isEnabled() Returns: {boolean}

Check whether the view is enabled.

Example

var enabled = MyView.isEnabled();

isLabelVisible() Returns: {boolean}

Get label visibility for text editor control

Inherited isValid() Returns: {boolean}

Return the valid status as last set by the setValid() method.

Example

var valid = MyView.isValid();

Inherited isVisible() Returns: {boolean}

Check whether the view is visible.

Example

var visible = MyView.isVisible();

Inherited propagateUpValueChange(event) Returns: {boolean}

Propagate the value change of the view up through the parent views.

Name Type Default Description

event {Event} Value change event (usually an onchange event)

Example

MyView.propagateUp(event);

Inherited recalculate()

Applicable only to formula-enabled views!
Triggers the re-evaluation of the formula
for the view, if a formula was 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 or disable the view.

Name Type Default Description

enabled {boolean} Enabled/read-only flag (true to enable view, false to disable/make read-only)

required {boolean} Enable or disable the required field flag for the view.

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 the view 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, "Fix your data entry"); //Make MyView invalid

Inherited setViewData(data, createPseudoBinding)

Set or update the bound data associated with the view. It applies only to views with bound data.

Note: It should only be used with simple type bindings, or complex type bindings with simple type properties.
It should not be used with bindings that have properties that are lists or compext types. For complex types, set the bindings by using
the binding.set pattern, as described in the Binding data and configuration options documentation section.

Name Type Default Description

data {Object} The value of the bound data. The parameter type must match the type of the bound data.

createPseudoBinding {boolean} If the value is set to true, the parameter 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 or hide the view.

Name Type Default Description

visible {boolean} Visibility flag (true to show the view, false to hide it)

collapse {boolean} Set it to true to collapse the view space when the option 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.

Example

MyView.show();

Inherited triggerFormulaUpdates([phase])

Broadcast 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();

Methods

Parent

Helpers