Panel
Creates a section that organizes and provides a common style for other views that are contained inside it.
Footer
| Footer text: | Text to put in the footer | String |
Appearance
| Icon: | Icon name, for example: calendar, clock-o, camera, cloud-upload, bell, info, file-text, etc... Check http://fontawesome.io/icons for a comprehensive list. (Note that the "fa-" prefix is optional) | String |
| Color style: | Color-based styling for this view (default, info, success, warning, danger, transparent) {Default | Primary | Success | Info | Warning | Danger | Transparent} |
PanelColorStyle |
| Light color: | Sets the fill color to a lighter shade, and changes title text to color selected in color style | Boolean |
| Full body color: | Fills the body with color when selected, instead of just the title | Boolean |
| Width: | The width in px, % or em.\r\nFor example\: 50px, 20%, 0.4em. If no unit is specified, px is assumed. | String |
| Body height: | Height in px, %, em\r\nFor example\: 50px, 20%, 0.4em. If no unit is specified, px is assumed | String |
Formula
| Title formula: | The formula or expression to set the section title. | String |
| Events | ||||||
| On Load: |
| |||||
| On Icon Click: |
| |||||
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"); |
getColorStyle()
Get the color style of the panel.
()
Returns:
{boolean}
Gets the content of the footer
getHelpText()
Returns:
{string}
Get help text associated with Table control
getIcon()
Returns:
{string}
Get icon keyword for section
getTitle()
Returns:
{string}
Get title for section
getType()
Returns:
{string}
Get descriptive string representing the type of control
getWidth()
Returns:
{string}
Get configured width for section (including unit)
Inherited
hide(collapseFlag)
Hide this view/control
| Name | Type | Default | Description |
| collapseFlag | {boolean} | Set to true to collapse the view (equivalent to a view setting of "NONE") |
Example
| MyView.hide(); |
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(); |
isFullBodyColor()
Returns:
{boolean}
Gets whether or not full body color is enabled
Inherited
isLabelVisible()
Returns:
{boolean}
Checks if control label is visible
Example
| var labelVisible = MyView.isLabelVisible(); |
isLightColor()
Returns:
{boolean}
Gets whether or not light colors are enabled
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); |
setColorStyle(style)
Sets color style of section. NOTE: to avoid ambiguity always set the color using "D"|"P"|"I"|"S"|"W"|"G"|"T"
| Name | Type | Default | Description |
| style | {string} | "DEFAULT"|"DEF"|"D"=Default | "PRIMARY"|"P"=Primary | "INFO"|INF"|"I"=Info | "SUCCESS"|"S"=Success | "WARNING"|"WARN"|"W"=Warning | "DANGER"|"G"=Danger | "TRANSPARENT"|"T"=Transparent |
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 |
(content, htmlFlag)
Sets whether or not the section color fills the section or just the title bar
| Name | Type | Default | Description |
| content | {string} | The content of the footer | |
| htmlFlag | {boolean} | {true | false} set to true if footer includes html, false otherwise |
setFullBodyColor(flag)
Sets whether or not the section color fills the section or just the title bar
| Name | Type | Default | Description |
| flag | {boolean} | {true | false} |
setHelpText(helptext)
Set help text for Table control
| Name | Type | Default | Description |
| helptext | {string} | Help text for the control |
setIcon(icon)
Set section icon
| Name | Type | Default | Description |
| icon | {string} | See {@link http://fontawesome.io/icons Font Awesome} for a comprehensive list of icons. Refer to the knowledge center for the latest Font Awesome version. |
Inherited
setLabelVisible(visible)
Show/hide the label of this view/control
| Name | Type | Default | Description |
| visible | {boolean} | Label visibility flag (true to show view label, false to hide) |
Example
| MyView.setLabelVisible(false); |
setLightColor(flag)
Sets whether light color styles are used
| Name | Type | Default | Description |
| flag | {boolean} | {true | false} |
setTitle(title)
Set title of section
| Name | Type | Default | Description |
| title | {string} | Section title |
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" |
setWidth(width)
Set width of section (e.g. 50px, 20%, 2em - omitting the unit assumes px)
| Name | Type | Default | Description |
| width | {string} | Section width |
Inherited
show()
Show this view/control
Example
| MyView.show(); |
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(); |