Well

Creates a section that allows multiple views to be placed inside a styled background.

Appearance

Color style:	Color-based styling for this view {Default \| Primary \| Info \| Success \| Warning \| Danger}	`ButtonColorStyle`
Color darkness:	Darkness of configured color style {None \| Dark \| Darker}	`WellColorDarkness`
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 of the icon in px or em.\r\nFor 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}	`WellIconPosition`
Vertical alignment:	Vertical alignment of child views {Top \| Middle \| Bottom}	`VerticalAlignment`
Padding:	Padding around well	`String`
Border radius:	Radius of curvature for corners.	`String`
Width:	The width in px, % or em.\r\nFor example\: 50px, 20%, 0.4em. If no unit is specified, px is assumed.	`String`
Height:	Height in px, %, em\r\nFor 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")`

Extends:

com.ibm.bpm.coach.CoachView

Methods:

Inherited addClass(name, [replaced])

Add/replace CSS class(es) for this control

Name	Type	Default	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}`		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() Returns: {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"

getHeight() Returns: {string}

Get configured height for well (including unit)

getType() Returns: {string}

Get descriptive string representing the type of control

getWidth() Returns: {string}

Get configured width for well (including unit)

Inherited hide(collapseFlag)

Hide this view/control

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}

Indicates bound status of control.

Inherited isEnabled() Returns: {boolean}

Checks if the view is enabled or not

Example

var enabled = MyView.isEnabled();

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

Name	Type	Default	Description
event	`{Event}`		Value change event (usually an onchange event)

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

Inherited setEnabled(enabled, required)

Enable/disable this view/control

Name	Type	Default	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	Default	Description
height	`{string}`		Well height

setIcon(icon)

Sets icon to display on the well

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.

setIconSize(size)

Sets size of icon

Name	Type	Default	Description
size	`{string}`		Icon size

setRadius(radius)

Sets radius (roundness) of well

Name	Type	Default	Description
radius	`{string}`		Corner radius of curvature

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

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

Name	Type	Default	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	Default	Description
width	`{string}`		Well width

Inherited show()

Show this view/control

Example

MyView.show();

Inherited triggerFormulaUpdates([phase])

Broadcasts 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