Class: CollapsiblePanel

CollapsiblePanel

The Collapsible Panel is a section that comes with many easy to configure behavior and appearance options. A CollapsiblePanel control provides the following configuration properties in Process Designer:

Formula

Title Formula: Formula/expression to use for calculating section title string

Behavior

Initially Collapsed: Set to true to keep section collapsed on load boolean
Panel Group Name: If a panel is in a group, only one panel in the same group can be open at any time - the others collapse automatically string

Appearance

Color Style: Color-based styling for this control (default, info, success, warning, danger)
{Default | Primary | Success | Info | Warning | Danger}
string
Width: Width in px, %, em For example: 50px, 20%, 0.4em. If no unit is specified, px is assumed string
Body Height: Height in px, em For example: 50px, 0.4em. If no unit is specified, px is assumed string

Events

On Load:
Description: Triggers whenever the view is loaded.
Example:
if(me.isExpand()){me.collapse();}
On Expand:
Description: Triggers when the control expands.
Example:
me.setColorStyle("S")
On Collapse:
Description: Triggers when the control collapses.
Example:
me.setColorStyle("");${CollapsiblePanel1}.expand()
Article(s)
Collapsible Panel

new CollapsiblePanel()

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");
Collapse the panel programmatically
Expand the panel programmatically

getTitle(){string}

Get title for section
Returns:
Type Description
string

getType(){string}

Get descriptive string representing the type of control
Returns:
Type Description
string

getWidth(){string}

Get configured width for section (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();

isExpanded(){boolean}

Returns whether or not the panel is expanded
Returns:
Type Description
boolean
Checks if control label is visible
Returns:
Type Description
boolean Label visibility status
Example
var labelVisible = MyView.isLabelVisible();
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);

setColorStyle(style)

Set the color style of the panel. NOTE: to avoid ambiguity always set the color using "D"|"I"|"P"|"S"|"W"|"G"
Name Type Description
style string "DEFAULT"|"DEF"|"D"=Default | "INFO"|INF"|"I"=Info | "PRIMARY"|"P"=Primary | "SUCCESS"|"S"=Success | "WARNING"|"WARN"|"W"=Warning | "DANGER"|"ERROR"|"ERR"|"G"=Danger
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
Show/hide the label of this view/control
Name Type Description
visible boolean Label visibility flag (true to show view label, false to hide)
Example
MyView.setLabelVisible(false);

setTitle(title)

Set title of section
Name Type Description
title string Section title
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 section (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name Type Description
width string the width of the panel
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();