Class: RadioButton

RadioButton

The Radio Button Control is a control that can be used either individually or as a group. This control is commonly used to allow a user to make one or more mutually exclusive selections, such as gender or age group. A RadioButton control provides the following configuration properties in Process Designer:

Behavior

Tab Index: Form control tabbing sequence index. Tab indices start at 1, and may be set sparsely. integer
Value When Selected: Value the binding is set to when this radio button is selected string
Group Name: Group this radio button belongs to (Note: when radio button is selected, all other radio buttons in the same group will be deselected) string

Events

On Load:
Description: Triggers whenever the view is loaded.
Example:
if (me.isSelected()) ${Data1}.setValue(me.getSelectedValue())
On Selected:
Description: Triggers when this radio button is selected.
Example:
${Data1}.setValue(me.getSelectedValue())
Article(s)
Radio Button

new RadioButton()

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");
Set focus on this control
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();

getLabel(){string}

Get label associated with radio button control
Returns:
Type Description
string

getSelectedValue(){boolean}

Get the value of the radio button control when it is selected
Returns:
Type Description
boolean

getTabIndex(){integer}

Get tab index for radio button control
Returns:
Type Description
integer

getType(){string}

Get descriptive string representing the type of control
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();

isLabelVisible(){boolean}

Get label visibility for the radio button control
Returns:
Type Description
boolean

isSelected(){boolean}

Get selected state for radio button control
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);
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
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

setLabel(text)

Set label for radio button control
Name Type Description
text string Label for radio button

setLabelVisible(flag)

Set label visibility for radio button control
Name Type Description
flag boolean true | false

setSelected()

Set selected state for radio button control to true

setTabIndex(tabIndex)

Sets tab index of radio button control
Name Type Description
tabIndex integer Tab indices start at 1 and may be set sparsely
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"
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();