Class: Well

Well

The Well is a Section that allows multiple controls to be placed inside a styled background. A Well control provides the following configuration properties in Process Designer:

Appearance

Color Style: Color-based styling for this control
{Default | Primary | Info | Success | Warning | Danger}
string
Color Darkness: Darkness of configured color style
{None | Dark | Darker}
string
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
Icon Size: Font size for icon in px, em For example: 35px, 0.4em. If no unit is specified, px is assumed string
Icon Position: Icon position within well
{Bottom-Right | Bottom-Left | Top-Right | Top-Left}
string
Vertical Alignment: Vertical alignment of child controls
{Top | Middle | Bottom}
string
Padding: Padding around well string
Border Radius: Radius of curvature for corners string
Width: Width in px, %, em For example: 50px, 20%, 0.4em. If no unit is specified, px is assumed string
Height: Height in px, %, em For example: 50px, 20%, 0.4em. If no unit is specified, px is assumed string

Events

On Load:
Description: Triggers whenever the view is loaded.
Example:
me.setHeight("200px")
On Click:
Description: Triggers when well is clicked.
Example:
me.setHeight("500px")
Article(s)
Well

new Well()

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

click()

Programmatically click this well

getColorStyle(){string}

Gets color style of well. NOTE: This always returns the color as set, to avoid ambiguity always set the color using "D"|"P"|"I"|"S"|"W"|"G"
Returns:
Type Description
string

getHeight(){string}

Get configured height for well (including unit)
Returns:
Type Description
string

getType(){string}

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

getWidth(){string}

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

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

setHeight(height)

Set height of well (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name Type Description
height string Well height

setIcon(icon)

Sets icon to display on the well
Name Type Description
icon string see icon reference (Note: may exclude fa-)

setIconSize(size)

Sets size of icon
Name Type Description
size string Icon size
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);

setRadius(radius)

Sets radius (roundness) of well
Name Type Description
radius string Corner radius of curvature
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 well (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name Type Description
width string Well 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();