Link

Creates a link to an external web page or another page in your app.

Appearance

Width: The width in px, % or em.\r\nFor example\: 50px, 20%, 0.4em. If no unit is specified, px is assumed. String

Text alignment: The alignment of the output text relative to the width of the view.
{Default | Left | Center | Right} TextAlignment

Color style: The color style of the link. Note\: The color style applies only to the text, not the label.
{Default | Normal | Muted | Light-gray | Primary | Info | Success | Warning | Danger} ParagraphColorStyle

Size: The size of the text. Note\: The text size applies to both text and label.
{Default | Super-Large | Extra-Large | Larger | Large | Small | Smaller} OutputTextSizeStyle

Text weight: The weight of the link text. Note\: The text weight applies only to the text, not the label
{Default | Slim | Normal | Semi-bold | Bold} OutputTextWeightStyle

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

Link text: Text to set for the link String

Prevent multiple clicks: Prevents the user from clicking the link more than once. Only effective for a Boundary Event link type. Boolean

Link type: Set to Boundary Event to emit a boundary event within the service, URL to go to an outside page
{Boundary Event | URL} LinkType

Link URL: Only effective if Link Type is URL String

Open in same window: Open URL in the same window. The link type must be URL. Boolean

Formula

Text formula: The formula or expression to calculate link text. String

Events

On Load:

Description: Triggers whenever the view is loaded.

Example:

me.setText("Link to google!")

On Click:

Description: Triggers when link is clicked, before navigating away from page. If evaluated expression returns false, the click will not fire a boundary event.

Example:

return me.getText() != ""

On Boundary Event:

Description:

Triggers upon reaching a Stay On Page event after a boundary event is fired through this control. For information on the status context variable see the context.trigger() method in the Knowledge Center.

Context Variables	status {string}

Example:

me.setColorStyle("G")

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

getColorStyle() Returns: {string}

Gets color style of control. NOTE: This always returns the color as set, to avoid ambiguity always set the color using "H"|"D"|"M"|"L"|"P"|"I"|"S"|"W"|"G"|"T"

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

getHelpText() Returns: {string}

Get help text associated with link control

getLabel() Returns: {string}

Get label associated with link controls

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 Link control (e.g. 50px, 20%, 2em - omitting the unit assumes px)

getLinkURL() Returns: {string}

Get URL for link control

getSizeStyle() Returns: {string}

Gets size style of control. NOTE: This always returns the size as set, to avoid ambiguity always set the size using "R"|"X"|"G"|"L"|"S"|"M"|"D"

getTabIndex() Returns: {integer}

Get tab index for text control

getText() Returns: {string}

Get text for link control

getType() Returns: {string}

Get descriptive string representing the type of control

getWidth() Returns: {string}

Get configured width for link 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 link control

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

setColorStyle(style)

Sets color style of control. NOTE: to avoid ambiguity always set the color using "H"|"D"|"M"|"L"|"P"|"I"|"S"|"W"|"G"|"T"

Name Type Default Description

style {string} "NORMAL"|H"=Normal | "DEFAULT"|"DEF"|"D"=Default | "MUTED"|"M"=Muted | "LIGHT_GRAY"|"GRAY"|"LIGHTGRAY"|"LIGHT GRAY"|"LIGHT"|"L"=Light | "PRIMARY"|"P"=Primary | "INFO"|INF"|"I"=Info | "SUCCESS"|"S"=Success | "WARNING"|"WARN"|"W"=Warning | "ERROR"|"ERR"|"DANGER"|"G"=Danger | "TRANSPARENT"|"T"=Transparent

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

setHelpText(helptext)

Set help text for link control

Name Type Default Description

helptext {string} Help text for the control

setLabel(text)

Set label for control

Name Type Default Description

text {string} Label for 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

setLabelVisible(flag)

Set label visibility for text control

Name Type Default Description

flag {boolean} {true | false}

setLabelWidth(labelWidth)

Set label width of Link control (e.g. 50px, 20%, 2em - omitting the unit assumes px)

Name Type Default Description

labelWidth {string} Control's label width

setLinkURL(url)

Set URL for link control

Name Type Default Description

url {string} Set URL of control

setSizeStyle(style)

Sets size style of control. NOTE: to avoid ambiguity always set the size using "R"|"X"|"G"|"L"|"S"|"M"|"D"

Name Type Default Description

style {string} "SUPER-LARGE"|"SUPER LARGE"|"SUPER"|"R"=Super large | "EXTRA-LARGE"|"EXTRA LARGE"|"EXTRA"|"X"=Extra large | "LARGER"|"G"=Larger | "LARGE"|"L"=Large | "SMALL"|"S"=Small | "SMALLER"|"M"=Smaller | "DEFAULT"|"DEF"|"D"=Default

setTabIndex(tabIndex)

Sets tab index of text control

Name Type Default Description

tabIndex {integer} tab indices start at 1 and may be set sparsely

setText(text)

Set text for link control

Name Type Default Description

text {string} Output text of control

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 link control (e.g. 50px, 20%, 2em - omitting the unit assumes px)

Name Type Default Description

width {string} Width of control

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