Class: InputGroup

InputGroup

The Input Group control allows you to add an icon, text or menu to input controls such as Text, Text Area, or Integer controls for example. An InputGroup control provides the following configuration properties in Process Designer:

Appearance

Width: Width of the control (%, px) string
Label Placement: Set the label placement
{Top | Left}
string
Color Style: Button color
{Default | Primary | Info | Success | Warning | Danger}
string
Button Location: Select where to set the button in relation to the attached control
{Left | Right}
string
Button Kind: Set the style of button to attach to the contained control. The Menu option can only be used to specify a single menu option.
{Icon | Text | Menu}
string
Button Info: Set either the displayed text used with the Text and Menu kind options or the icon name for Icon kind. string

Events

On Load:
Description: This event is triggered when the control is loaded.
Example:
me.setIcon("rocket");
On Button Click:
Description: This event is triggered when the control is clicked.
Example:
${PopupMenu1}.setMenuVisible(!${PopupMenu1}.isMenuVisible())
Article(s)
Input Group

new InputGroup()

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

getButtonLocation(){string}

Gets horizontal location of button in the control. NOTE: This always returns the button placement as set, to avoid ambiguity always set the label placement using "L"|"R"
Returns:
Type Description
string
Retrieve bound data associated this view/control. Only works for views/controls with bound data.
Returns:
Type Description
Object Value of bound data. undefined if the view has no data binding.
Example
var dec1 = MyDecimal.getData();

getIcon(){string}

Gets the icon currently on display
Returns:
Type Description
string icon See icon reference for possible values (note the "fa-" prefix is optional)

getLabel(){string}

Get label associated with control
Returns:
Type Description
string

getLabelPlacement(){string}

Get label placement for control. NOTE: This always returns the label placement as set, to avoid ambiguity always set the label placement using "T"|"L"
Returns:
Type Description
string

getSizeStyle(){string}

Gets size style of control
Returns:
Type Description
string {"L"=Large | "S"=Small | "D"=Default}

getType(){string}

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

getWidth(){string}

Get configured width for the control (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();
Returns the valid status as last set by the setValid() method.
Returns:
Type Description
boolean Validity status. true if setValid(false, ...) was never called
Example
var valid = MyView.isValid();
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);
Only for formula-enabled views!
Explicitly triggers the re-evaluation of the formula for this view (if a formula has been specified). If the view is not formula-enabled, recalculate() does nothing.
Example
Text1.recalculate(); //If the formula for Text1 is: new Date().toString(), Text1 is updated to the current date/time

setButtonLocation(placement)

Sets horizontal location of button in the control. NOTE: to avoid ambiguity always set the label placement using "L" | "R"
Name Type Description
placement string "L"|"LEFT"=Left | "R"|"RIGHT"=right

setColorStyle(style)

Sets color style of the control. 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
Set/update bound data associated this view/control. Only works for views/controls with bound data.
Name Type Description
value Object Value of bound data. The type of this parameter must match the type of the bound data.
Example
MyView.setData("TEST"); //Updates bound data to the string 'TEST'
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

setIcon(icon)

Sets the icon to display
Name Type Description
icon string See icon reference for possible values (note the "fa-" prefix is optional)

setLabel(label)

Set label for control
Name Type Description
label string label text for the control

setLabelPlacement(placement)

Set label placement for control. NOTE: to avoid ambiguity always set the label placement using "T"|"L"
Name Type Description
placement string "T"|"TOP"=Top | "L"|"LEFT"=Left
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);

setSizeStyle(style)

Sets size style of control. NOTE: to avoid ambiguity always set the size style using "D"|"S"|"L"
Name Type Description
style string "DEFAULT"|"DEF"|"NORMAL"|"D"=Default | "SMALL"|"S"=Small | "LARGE"|"L"=Large
Flag this view/control as valid or invalid
Name Type Description
valid boolean Valid/invalid flag (true to set view valid, false to make it invalid - which typically shows the view with "invalid" styling and indicator)
errorText string Validation error text to show on the invalid-styled view
Example
MyView.setValid(false, "Please fix your data entry"); //Make MyView invalid
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 the control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name Type Description
width string width of the input group
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();