Class: DeferredSection

DeferredSection

The Deferred Section is used to allow lazy loading, which can contribute to efficiency in a Coaches operation since images outside of viewport are not loaded until the user scrolls to them. A DeferredSection control provides the following configuration properties in Process Designer:

Lazy-load automatically: loaded automatically after the specified delay has passed boolean
Delay for auto-loading: How long to wait (in milliseconds) before loading this section integer

Events

OnLazyLoad:
Description: This event is triggered when lazy load is done.
Example:
alert("Lazy load complete")
Articles
Deferred Section

new DeferredSection()

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

getDeferredView(index){CoachView}

Provides a reference to a child view loaded asynchronously through this section
Name Type Description
index integer of the child view in the deferred section (if ommitted, 0 is assumed)
Returns:
Type Description
CoachView

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

isLoaded(){boolean}

Tests whether this section is loaded or not
Returns:
Type Description
boolean
Checks whether or not view is visible
Returns:
Type Description
boolean Visibility status
Example
var visible = MyView.isVisible();

lazyLoad(delay, trigger){boolean}

Start the lazy load of this section
Name Type Description
delay integer value in milliseconds
trigger boolean the "On Lazy Loaded" event even if the section is already loaded
Returns:
Type Description
boolean true if the load was successfully initiated, false if the section was already loaded
Example
Deferred_Section1.lazyLoad(2000); // starts the lazy load in 2 seconds
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);
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();