Breadcrumbs

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

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

appendItem(elt, data)

appends a new item in the last index of the breadcrumbs control

Name Type Default Description

elt {string} The name of the item,

data {any} the value of the item

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

getItemAt() Returns: {any}

Get item at the index from the breadcrumbs control

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() Returns: {integer}

Get number of items in the breadcrumb trail

getLabel() Returns: {string}

Get label associated with breadcrumbs control

getType() Returns: {string}

returns the descriptive identifier for this control

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

removeItem(index)

removes an item at the index of the breadcrumbs control

Name Type Default Description

index {integer} the index of the item

removeLastItem()

removes the last item in the breadcrumbs controls

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

setItemAt(level, text, data)

Set the name and value of an item in the breadcrumbs control

Name Type Default Description

level {integer} the index of an item

text {string} the name of the item

data {any} the 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 Default Description

label {string} Label for the control

setLabelVisible(flag)

Set label visibility for breadcrumbs control

Name Type Default Description

flag {boolean} {true | false} Set to false to hide label

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"

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

trim(index)

removes the item and all following items

Name Type Default Description

index {integer} the index of the item

Methods

Parent

Helpers