new HorizontalSplit()
This constructor is never used explicitly.
Extends
Members
Methods
-
inherited addClass(name, replaced)
-
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)
-
Collapse pane at the specified index
Name Type Description index
integer Pane index to collapse -
expandPane(index)
-
Expand pane at the specified index
Name Type Description index
integer Pane index to expand -
getHeight(){string}
-
Get configured height for section (including unit)
Returns:
Type Description string -
getPaneCount(){integer}
-
Count the number of panes
Returns:
Type Description integer -
getType(){string}
-
Get descriptive string representing the type of control/section
Returns:
Type Description string -
inherited hide(collapseFlag)
-
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}
-
Indicates bound status of control.
Returns:
Type Description boolean True if the control is bound to coach data. -
inherited isEnabled(){boolean}
-
Checks if the view is enabled or not
Returns:
Type Description boolean Enabled status Example
var enabled = MyView.isEnabled();
-
inherited isLabelVisible(){boolean}
-
Checks if control label is visible
Returns:
Type Description boolean Label visibility status Example
var labelVisible = MyView.isLabelVisible();
-
isPaneCollapsed(index){boolean}
-
Check if pane at
index
is collapsedName Type Description index
integer Pane index to check Returns:
Type Description boolean -
inherited isVisible(){boolean}
-
Checks whether or not view is visible
Returns:
Type Description boolean Visibility status Example
var visible = MyView.isVisible();
-
inherited propagateUpValueChange(event){boolean}
-
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)
-
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)
-
Set height of section (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name Type Description height
string -
inherited setLabelVisible(visible)
-
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)
-
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 whenvisible
is set tofalse
.Examples
MyView.setVisible(false, false); //Equivalent to MyView.hide()
MyView.setVisible(false, true); // Sets visibility to "None"
-
Show this view/control
Example
MyView.show();
-
togglePane(index)
-
Toggle pane at the specified index between collapsed and expanded
Name Type Description index
integer Pane index to toggle -
inherited triggerFormulaUpdates(phase)
-
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();