Spinner
Indicates that the system is busy performing an action, such as loading, processing, or retrieving information. While the action is in progress, the execution of other views in the same page is stalled.
Appearance
| Size: | Size-based styling for this view (default, small) {Default | Small} |
SpinnerSizeStyle |
| Events | ||||||
| On Load: |
| |||||
| On Show: |
| |||||
| Description: | This event is fired when the control is closed. |
| Example: | |
Extends:
Methods:
Inherited
addClass(name, [replaced])
Add/replace CSS class(es) for this control
| Name | Type | Default | 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} | 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"); |
getHelpText()
Returns:
{string}
Get help text associated with spinner control
getLabel()
Returns:
{string}
Get label associated with this control
getSizeStyle()
Returns:
{string}
Gets the size style of the control.
getType()
Returns:
{string}
Get descriptive string representing the type of control
hide()
hide this view/control
Inherited
isBound()
Returns:
{boolean}
Indicates bound status of control.
Inherited
isEnabled()
Returns:
{boolean}
Checks if the view is enabled or not
Example
| var enabled = MyView.isEnabled(); |
isLabelVisible()
Returns:
{boolean}
Get label visibility for this control
Inherited
isVisible()
Returns:
{boolean}
Checks whether or not view is visible
Example
| var visible = MyView.isVisible(); |
Inherited
propagateUpValueChange(event)
Returns:
{boolean}
Propagates value change of control up through parent views
| Name | Type | Default | Description |
| event | {Event} | Value change event (usually an onchange event) |
Example
| MyView.propagateUp(event); |
Inherited
setEnabled(enabled, required)
Enable/disable this view/control
| Name | Type | Default | 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 |
setHelpText(helptext)
Set help text for spinner control
| Name | Type | Default | Description |
| helptext | {string} | Help text for the control |
setLabel(label)
Set label for this control
| Name | Type | Default | Description |
| label | {string} | set the label name. |
setLabelVisible(flag)
Set label visibility for this control
| Name | Type | Default | Description |
| flag | {boolean} | sets the visibility {true | false} |
setSizeStyle(size)
Set the size of the control. NOTE: to avoid ambiguity always set the size using "D"|"S"
| Name | Type | Default | Description |
| size | {string} | "DEFAULT"|"D"=Default | "SMALL"|"S"=small |
Inherited
setViewData(data, createPseudoBinding)
Set/update bound data associated this view/control. Only works for views/controls with bound data.
Note: Should only be used with simple type bindings, or complex type bindings with simple type properties.
Should not be used with bindings that have properties that are lists or compext types. For complex types, set bindings using
the
Note: Should only be used with simple type bindings, or complex type bindings with simple type properties.
Should not be used with bindings that have properties that are lists or compext types. For complex types, set bindings using
the
binding.set pattern detailed in the Knowlege Center section Binding Data and Configuration Options| Name | Type | Default | Description |
| data | {Object} | Value of bound data. The type of this parameter must match the type of the bound data. | |
| createPseudoBinding | {boolean} | If set to true, creates a pseudo binding if there is no current binding. |
Example
| MyView.setViewData("TEST"); //Updates bound data to the string 'TEST' |
Inherited
setVisible(visible, collapse)
Show/hide this view/control
| Name | Type | Default | 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()
Show this view/control
Inherited
triggerFormulaUpdates([phase])
Broadcasts the expression trigger for the specified view
| Name | Type | Default | Description |
| phase | {int} | bpmext.ui.PHASE_NORMAL | The phase we are currently in |
Example
| MyView.triggerFormulaUpdates(); |