Create a pane which will be mounted into a paneManager layout.
More...
#include "remoto!stdlib:js/paneManager/paneManager.js"
|
| pane (layout, object) |
|
| activate () |
| DOCME. More...
|
|
| applyDiff (data, user) |
|
| applyReleaseLock (data) |
|
| applyRequestError (command, id, reason) |
|
| applyRequestLock (data) |
|
| applyRequestSuccess (command, id, data, metadata) |
|
| applySettings (settings) |
|
| applySubscription (data, metadata) |
|
| area () |
|
| attach () |
| Provides an opportunity for a pane to pass an attach command to its object. More...
|
|
| attached () |
| Detects is this pane is attached to the DOM. More...
|
|
| createHTML () |
|
| deactivate () |
| If a deactivate method is present on this pane's _object, call it. More...
|
|
| destroy () |
| DOCME. More...
|
|
| detach () |
| Detach this._html and call this._object.detach() . More...
|
|
| find (p, type) |
|
| hasHelp () |
|
| mounted (mountState) |
| Notify this pane that the mounted state has changed. More...
|
|
| rename (name) |
|
| resize () |
| DOCME. More...
|
|
| saveLayout () |
| Build the layout for this pane. More...
|
|
| triggerCurrentPane () |
| DOCME. More...
|
|
|
getter | help |
| A getter that will return a pane object's help message, or a default message indicating that no help is available. More...
|
|
getter | paneType |
| A getter which will calculate the pane type based on the _object, or return the default "pane". More...
|
|
Create a pane which will be mounted into a paneManager layout.
The pane will want to create an object to view information, which will want to be a subclass of pane().
◆ pane()
◆ activate()
◆ applyDiff()
◆ applyReleaseLock()
◆ applyRequestError()
applyRequestError |
( |
|
command, |
|
|
|
id, |
|
|
|
reason |
|
) |
| |
◆ applyRequestLock()
◆ applyRequestSuccess()
applyRequestSuccess |
( |
|
command, |
|
|
|
id, |
|
|
|
data, |
|
|
|
metadata |
|
) |
| |
- Parameters
-
command | |
id | |
data | |
metadata | DOCME |
◆ applySettings()
applySettings |
( |
|
settings | ) |
|
◆ applySubscription()
applySubscription |
( |
|
data, |
|
|
|
metadata |
|
) |
| |
◆ area()
◆ attach()
Provides an opportunity for a pane to pass an attach command to its object.
Note that this does not append this._html, it only calls this._object.attach()
.
◆ attached()
Detects is this pane is attached to the DOM.
- Returns
- True if this._html is attached to the DOM.
◆ createHTML()
◆ deactivate()
If a deactivate
method is present on this pane's _object, call it.
◆ destroy()
◆ detach()
Detach this._html
and call this._object.detach()
.
◆ find()
◆ hasHelp()
◆ help()
A getter that will return a pane object's help message, or a default message indicating that no help is available.
- See also
- paneManager::pane::hasHelp()
◆ mounted()
Notify this pane that the mounted state has changed.
This is used for remote VFS connections.
- Parameters
-
mountState | A boolean indicating the new mount state. |
◆ paneType()
A getter which will calculate the pane type based on the _object, or return the default "pane".
This is helpful when a pane in the layout wants to use keepType to override the type returned from the VFS, and we want to register or unregister it, or save the layout
◆ rename()
◆ resize()
◆ saveLayout()
Build the layout for this pane.
- Returns
- The layout
◆ triggerCurrentPane()
The documentation for this class was generated from the following file: