Class: Panel

Panel

The Panel control is a container that can hold any controls and provides a common style for the group of controls. A Panel control provides the following configuration properties in Process Designer:

Formula

Title Formula: Formula/expression to use for setting the section title string

Appearance

Icon: Icon name, for example: calendar, clock-o, camera, cloud-upload, bell, info, file-text, etc... Check http://fontawesome.io/icons for a comprehensive list. (Note that the "fa-" prefix is optional) string
Color Style: Color-based styling for this control (default, info, success, warning, danger, transparent)
{Default | Primary | Success | Info | Warning | Danger | Transparent}
string
Light Color: Sets the fill color to a lighter shade, and changes title text to color selected in color style boolean
Full Body Color: Fills the body with color when selected, instead of just the title boolean
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, 20%, 0.4em. If no unit is specified, px is assumed string

Footer

Footer Text: Text to put in the footer string

Events

On Load:
Description: Triggers whenever the view is loaded.
Example:
me.setWidth(${Table1}.getWidth())
On Icon Click:
Description: Triggers whenever the panel icon is clicked.
Example:
me.setColorStyle(me.getColorStyle() == "S" ? "G" : "S")
Article(s)
Panel

new Panel()

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

getFooter(){boolean}

Gets the content of the footer
Returns:
Type Description
boolean

getIcon(){string}

Get icon keyword for section
Returns:
Type Description
string

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

isFullBodyColor(){boolean}

Gets whether or not full body color is enabled
Returns:
Type Description
boolean
Checks if control label is visible
Returns:
Type Description
boolean Label visibility status
Example
var labelVisible = MyView.isLabelVisible();

isLightColor(){boolean}

Gets whether or not light colors are enabled
Returns:
Type Description
boolean
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)

Sets color style of section. NOTE: to avoid ambiguity always set the color using "D"|"P"|"I"|"S"|"W"|"G"|"T"
Name Type Description
style string "DEFAULT"|"DEF"|"D"=Default | "PRIMARY"|"P"=Primary | "INFO"|INF"|"I"=Info | "SUCCESS"|"S"=Success | "WARNING"|"WARN"|"W"=Warning | "DANGER"|"G"=Danger | "TRANSPARENT"|"T"=Transparent
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

setFooter(content, htmlFlag)

Sets whether or not the section color fills the section or just the title bar
Name Type Description
content string The content of the footer
htmlFlag boolean {true | false} set to true if footer includes html, false otherwise

setFullBodyColor(flag)

Sets whether or not the section color fills the section or just the title bar
Name Type Description
flag boolean {true | false}

setIcon(icon)

Set section icon
Name Type Description
icon string Icons keywords can be found at http://fontawesome.io/icons/
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);

setLightColor(flag)

Sets whether light color styles are used
Name Type Description
flag boolean {true | 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 Section width
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();