Panel

Creates a section that organizes and provides a common style for other views that are contained inside it.

Footer

Footer text: Text to put in the footer 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 view (default, info, success, warning, danger, transparent)
{Default | Primary | Success | Info | Warning | Danger | Transparent} PanelColorStyle

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: The width in px, % or em.\r\nFor example\: 50px, 20%, 0.4em. If no unit is specified, px is assumed. String

Body height: Height in px, %, em\r\nFor example\: 50px, 20%, 0.4em. If no unit is specified, px is assumed String

Formula

Title formula: The formula or expression to set the section title. 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")

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

getColorStyle()

Get the color style of the panel.

getFooter() Returns: {boolean}

Gets the content of the footer

getHelpText() Returns: {string}

Get help text associated with Table control

getIcon() Returns: {string}

Get icon keyword for section

getTitle() Returns: {string}

Get title for section

getType() Returns: {string}

Get descriptive string representing the type of control

getWidth() Returns: {string}

Get configured width for section (including unit)

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

isFullBodyColor() Returns: {boolean}

Gets whether or not full body color is enabled

Inherited isLabelVisible() Returns: {boolean}

Check whether the view label is visible.

Example

var labelVisible = MyView.isLabelVisible();

isLightColor() Returns: {boolean}

Gets whether or not light colors are enabled

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

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

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

setFooter(content, htmlFlag)

Sets whether or not the section color fills the section or just the title bar

Name Type Default 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 Default Description

flag {boolean} {true | false}

setHelpText(helptext)

Set help text for Table control

Name Type Default Description

helptext {string} Help text for the control

setIcon(icon)

Set section icon

Name Type Default Description

icon {string} See {@link http://fontawesome.io/icons Font Awesome} for a comprehensive list of icons. Refer to the knowledge center for the latest Font Awesome version.

Inherited setLabelVisible(visible)

Show or hide the view label.

Name Type Default 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 Default Description

flag {boolean} {true | false}

setTitle(title)

Set title of section

Name Type Default Description

title {string} Section title

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"

setWidth(width)

Set width of section (e.g. 50px, 20%, 2em - omitting the unit assumes px)

Name Type Default Description

width {string} Section width

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

Methods

Parent

Helpers