Class: HorizontalSplit

HorizontalSplit

The Horizontal Split section is used to hold content inside it horizontally (stacked next to each another) and allows for content to be split into two or more sections. A HorizontalSplit control provides the following configuration properties in Process Designer:

Appearance
Height: Optional - Default at 100% of its container (but container must have explicity set height) string
Pane Specs: Specify various appearance variables for each pane, such as width, handle location, etc. SplitPaneSpec[]
Size Width when expanded (in px, %, em, etc...) string
Collapsed size Width when collapsed (in px, %, em, etc...) string
Splitter thickness Thickness of divider (in px, %, em, etc...) string
Handle location Location of handle for expanding/collapsing
{None | Middle | Top | Bottom}		 string

Events
On Load:
Description: Triggers whenever the view is loaded.
Example: 
me.collapsePane(me.getPaneCount() - 1)
On Pane Collapsed:
Description: Triggers when a pane is collapsed.
Example: 
${PaneStatus}.setText("Last Pane Collapsed: " + paneIndex);
Context Variables paneIndex {int}
On Pane Expanded:
Description: Triggers when a pane is expanded.
Example: 
${PaneStatus}.setText("Last Pane Expanded: " + paneIndex);
Context Variables paneIndex {int}
Articles
Horizontal Split

new HorizontalSplit()

HorizontalSplit.js, line 42
This constructor is never used explicitly.

Extends

Members

uibpmext.ui.View

Methods

inherited addClass(name, replaced)

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 2466
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");

collapsePane(index)

HorizontalSplit.js, line 194
Collapse pane at the specified index
Name Type Description
index integer Pane index to collapse

expandPane(index)

HorizontalSplit.js, line 202
Expand pane at the specified index
Name Type Description
index integer Pane index to expand

getHeight(){string}

HorizontalSplit.js, line 169
Get configured height for section (including unit)
Returns:
Type Description
string

getPaneCount(){integer}

HorizontalSplit.js, line 186
Count the number of panes
Returns:
Type Description
integer

getType(){string}

HorizontalSplit.js, line 218
Get descriptive string representing the type of control/section
Returns:
Type Description
string

inherited hide(collapseFlag)

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 1861
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();

inherited isBound(){boolean}

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 2088
Indicates bound status of control.
Returns:
Type Description
boolean True if the control is bound to coach data.

inherited isEnabled(){boolean}

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 2034
Checks if the view is enabled or not
Returns:
Type Description
boolean Enabled status
Example
var enabled = MyView.isEnabled();

inherited isLabelVisible(){boolean}

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 1835
Checks if control label is visible
Returns:
Type Description
boolean Label visibility status
Example
var labelVisible = MyView.isLabelVisible();

isPaneCollapsed(index){boolean}

HorizontalSplit.js, line 177
Check if pane at index is collapsed
Name Type Description
index integer Pane index to check
Returns:
Type Description
boolean

inherited isVisible(){boolean}

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 1943
Checks whether or not view is visible
Returns:
Type Description
boolean Visibility status
Example
var visible = MyView.isVisible();

inherited propagateUpValueChange(event){boolean}

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 2403
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);

inherited setEnabled(enabled, required)

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 1959
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

setHeight(height)

HorizontalSplit.js, line 161
Set height of section (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name Type Description
height string

inherited setLabelVisible(visible)

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 1874
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);

inherited setVisible(visible, collapse)

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 1887
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"

inherited show()

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 1849
Show this view/control
Example
MyView.show();

togglePane(index)

HorizontalSplit.js, line 210
Toggle pane at the specified index between collapsed and expanded
Name Type Description
index integer Pane index to toggle

inherited triggerFormulaUpdates(phase)

BPMExt-Core/com/salientprocess/bpm/views/bpmext.js, line 4229
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();