Methods

addClass
appendItem
getData
getItemAt
getItemCount
getLabel
getType
hide
isBound
isEnabled
isLabelVisible
isVisible
propagateUpValueChange
recalculate
removeItem
removeLastItem
setEnabled
setItemAt
setLabel
setLabelVisible
setViewData
setVisible
show
triggerFormulaUpdates
trim

Parent

CoachView

Helpers

bpmext.log
bpmext.number
bpmext.text
bpmext.ui
bpmext.ui.View
bpmext.ui.util
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:
Methods:
Inherited addClass(name, [replaced])
Add/replace CSS class(es) for this control
NameTypeDefaultDescription
name{string}CSS class name(s) to add to the control. Separate class names by a space if more than one class.
replaced{string}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(elt, data)
appends a new item in the last index of the breadcrumbs control
NameTypeDefaultDescription
elt{string}The name of the item,
data{any}the value of the item
Inherited getData() Returns: {Object}
Retrieve bound data associated this view/control. Only works for views/controls 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 this view/control
NameTypeDefaultDescription
collapseFlag{boolean}Set to true to collapse the view (equivalent to a view setting of "NONE")
Example
MyView.hide();
Inherited isBound() Returns: {boolean}
Indicates bound status of control.
Inherited isEnabled() Returns: {boolean}
Checks if the view is enabled or not
Example
var enabled = MyView.isEnabled();
isLabelVisible() Returns: {boolean}
Get label visibility for breadcrumbs control
Inherited isVisible() Returns: {boolean}
Checks whether or not view is visible
Example
var visible = MyView.isVisible();
Inherited propagateUpValueChange(event) Returns: {boolean}
Propagates value change of control up through parent views
NameTypeDefaultDescription
event{Event}Value change event (usually an onchange event)
Example
MyView.propagateUp(event);
Inherited recalculate()
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
NameTypeDefaultDescription
index{integer}the index of the item
removeLastItem()
removes the last item in the breadcrumbs controls
Inherited setEnabled(enabled, required)
Enable/disable this view/control
NameTypeDefaultDescription
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(level, text, data)
Set the name and value of an item in the breadcrumbs control
NameTypeDefaultDescription
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
NameTypeDefaultDescription
label{string}Label for the control
setLabelVisible(flag)
Set label visibility for breadcrumbs control
NameTypeDefaultDescription
flag{boolean}{true | false} Set to false to hide label
Inherited setViewData(data, createPseudoBinding)
Set/update bound data associated this view/control. Only works for views/controls with bound data.

Note: Should only be used with simple type bindings, or complex type bindings with simple type properties.
Should not be used with bindings that have properties that are lists or compext types. For complex types, set bindings using
the binding.set pattern detailed in the Knowlege Center section Binding Data and Configuration Options
NameTypeDefaultDescription
data{Object}Value of bound data. The type of this parameter must match the type of the bound data.
createPseudoBinding{boolean}If set to true, 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/hide this view/control
NameTypeDefaultDescription
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"
Inherited show()
Show this view/control
Example
MyView.show();
Inherited triggerFormulaUpdates([phase])
Broadcasts the expression trigger for the specified view
NameTypeDefaultDescription
phase{int}bpmext.ui.PHASE_NORMALThe phase we are currently in
Example
MyView.triggerFormulaUpdates();
trim(index)
removes the item and all following items
NameTypeDefaultDescription
index{integer}the index of the item