Class: Breadcrumbs

Breadcrumbs

This control allows you to leave a clickable breadcrumb trail. A Breadcrumbs control provides the following configuration properties in Process Designer:

Events

On Load:
Description: Triggers whenever the view is loaded.
Example:
console.log("BreadCrumbs loaded")
On Click:
Description: Triggers when a breadcrumb is clicked.
Example:
alert("BreadCrumb with label [" + label + "] on level " + item.level + " has data (if any) " +item.data);
Context Variables label {String} item {object}
Properties label
level
data
Articles
Button
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");

appendItem(The, the)

appends a new item in the last index of the breadcrumbs control
Name Type Description
The string name of the item,
the any value of the item
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();

getItemAt(){any}

Get item at the index from the breadcrumbs control
Returns:
Type Description
any
Example
var breadcrumb = page.ui.get("breadcrumbs1"); var name = breadcrumb.getItemAt(0).name; //returns the name of the first item in the breadcrumbs control

getItemCount(){integer}

Get number of items in the breadcrumb trail
Returns:
Type Description
integer

getLabel(){string}

Get label associated with breadcrumbs control
Returns:
Type Description
string

getType(){string}

returns the descriptive identifier for this control
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 breadcrumbs 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

removeItem(index)

removes an item at the index of the breadcrumbs control
Name Type Description
index integer the index of the item

removeLastItem()

removes the last item in the breadcrumbs controls
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

setItemAt(the, the, the)

Set the name and value of an item in the breadcrumbs control
Name Type Description
the integer index of an item
the string name of the item
the any value of the item
Example
var breadcrumb = page.ui.get("breadcrumbs1"); breadcrumb.setItemAt (0, "Level 1", 1); // sets name and value for the first item to "Level 1" and 1

setLabel(label)

Set label for breadcrumbs control
Name Type Description
label string Label for the control

setLabelVisible(flag)

Set label visibility for breadcrumbs control
Name Type Description
flag boolean {true | false} Set to false to hide label
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"
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();

trim(index)

removes the item and all following items
Name Type Description
index integer the index of the item
Documentation generated by JSDoc 3.4.0-dev on Tue Apr 10 2018 13:53:21 GMT-0700 (PDT)