Class: Link

Link

The Link control creates a link to an outside webpage or can be set to a boundary event within a service. A Link control provides the following configuration properties in Process Designer:

Formula

Text Formula: Formula/expression to use for calculating link text string

Behavior

Tab Index: Form control tabbing sequence index. Tab indices start at 1, and may be set sparsely. 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}
string
Link URL: Only effective if Link Type is URL string
Open In Same Window: Open URL in same window (only if link type is URL) boolean

Appearance

Width: Width in px, %, em For example: 50px, 20%, 0.4em. If no unit is specified, px is assumed string
Text Alignment: Set the alignment of the output text relative to the width of the control
{Left | Center | Right}
string
Color Style: Set the color style for the link. Note: The color style only applies to the text, not the label
{Default | Normal | Muted | Light-gray | Primary | Info | Success | Warning | Danger}
string
Size Style: Set the size style of the text. Note: The text size applies to both text and label
{Default | Super-Large | Extra-Large | Larger | Large | Small | Smaller}
string
Text Weight: Set the weight of the link text. Note: The text weight only applies to the text, not the label
{Default | Slim | Normal | Semi-bold | Bold}
string
Label Placement: Set the label position. Note: Labels on the left will change the specified width of the control
{Top | Left}
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")
Article(s) Link
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");

getColorStyle(){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"
Returns:
Type Description
string
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();

getLabel(){string}

Get label associated with link controls
Returns:
Type Description
string

getLabelPlacementt(){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"
Returns:
Type Description
string

getSizeStyle(){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"
Returns:
Type Description
string

getTabIndex(){integer}

Get tab index for text control
Returns:
Type Description
integer

getText(){string}

Get text for link 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 link 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 link 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

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

setLabel(text)

Set label for control
Name Type 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 Description
placement string "T"|"TOP"=Top | "L"|"LEFT"=Left

setLabelVisible(flag)

Set label visibility for text control
Name Type Description
flag boolean {true | false}

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 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 Description
tabIndex integer tab indices start at 1 and may be set sparsely

setText(text)

Set text for link control
Name Type Description
text string Output text of control
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 link control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name Type Description
width string Width of control
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();