Class: ResponsiveSensor

ResponsiveSensor

Responsive Sensors are used in conjunction with Horizontal and Vertical Layouts to change the way the page displays based on screen/window size. A ResponsiveSensor control provides the following configuration properties in Process Designer:

Box Factors: Names and page widths at which responsive functionality is triggered. Responsive functionality at each threshold can be controlled under the Responsive config options of the sections themselves (e.g. vertical or horizontal sections). BoxFactor[]
Name Box factor name. This is the name that will be referenced by responsive horizontal and vertical layouts string
Width up to Maximum width this box factor applies to integer

Events

On Load:
Description: Triggers whenever the view is loaded.
Example:
me.refreshLayout()
On Responsive Boundary:
Description: Triggers when the view hits a Box Factor boundary.
Example:
console.log(event.boxFactor)
Context Variables event {object}
Properties boxFactor
lowerBound
upperBound
width
Article(s)
Responsive Sensor

new ResponsiveSensor()

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

getActiveBoxFactor(){string}

Returns the active box factor based on the current sensor width and how the width maps to the box factors configured.
Returns:
Type Description
string The box factor name

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();
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();
Pauses responsive behavior
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);

refreshLayout()

Forces the layout to refresh (even if layout is paused)
Resumes responsive behavior
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
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);
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();