Constructor
new EmperorViewControllerABC(uiState, container, title, description) → {EmperorViewControllerABC}
Parameters:
| Name | Type | Description |
|---|---|---|
uiState |
UIState | the shared state object |
container |
Node | Container node to create the controller in. |
title |
String | Title of the tab. |
description |
String | Helper description. |
- Source:
Returns:
Returns an instance of the EmperorViewControllerABC.
Members
$body :Node
jQuery element for the body, which contains the lowermost elementsdisplayed in tab. This goes below the header.
Type:
- Node
- Source:
$canvas :Node
jQuery element for the canvas, which contains the header and the body.
Type:
- Node
- Source:
$container :Node
jQuery element for the parent container.
Type:
- Node
- Source:
$header :Node
jQuery element for the header which contains the uppermost elementsdisplayed in a tab.
Type:
- Node
- Source:
active :Boolean
Indicates whether the tab is front most
Type:
- Boolean
- Default Value:
- false
- Source:
description :String
Human-readable description of the tab.
Type:
- String
- Source:
enabled :Boolean
Indicates if tab can be accessed.
Type:
- Boolean
- Default Value:
- true
- Source:
identifier :String
Unique hash identifier for the tab instance.
Type:
- String
- Default Value:
- "EMPtab-xxxxxxx"
- Source:
title :String
Human-readable title of the tab.
Type:
- String
- Source:
UIState :UIState
The shared state
Type:
- UIState
- Source:
Methods
forceRefresh()
Writes the current settings to the active decomposition view(s). Will be called when the decomposition view is swapped out for a different view type.
- Source:
fromJSON(parsed)
Decodes JSON string and modifies its own instance variables accordingly.
Parameters:
| Name | Type | Description |
|---|---|---|
parsed |
Object | JSON string representation of an instance. |
- Source:
resize(width, height)
Resizes the container, note that the body will take whatever space is available after considering the size of the header. The header shouldn't have height variable objects, once added their height shouldn't really change.
Parameters:
| Name | Type | Description |
|---|---|---|
width |
Float | the container width. |
height |
Float | the container height. |
- Source:
setActive(trulse)
Sets whether or not the tab is visible.
Parameters:
| Name | Type | Description |
|---|---|---|
trulse |
Boolean | option to activate tab (i.e. move tab to foreground). |
- Source:
setEnabled(trulse)
Sets whether or not elements in the tab can be modified.
Parameters:
| Name | Type | Description |
|---|---|---|
trulse |
Boolean | option to enable elements. |
- Source:
toJSON() → {Object}
Converts the current instance into a JSON string.
- Source:
Returns:
ready to serialize representation of self.
- Type
- Object