Insert raw html into a pane. More...
#include "remoto!stdlib:js/panes/panes/staticHtml.js"
Public Member Functions | |
| staticHtml (layout) | |
| applyDiff (diff, user) | |
| Apply a diff to this pane. More... | |
| applySettings (settings) | |
| attach () | |
| This node has been attached to the DOM. More... | |
| createHTML () | |
Create the html representation of this pane, and store that DOM element as this._html. More... | |
| destroy () | |
| Destroy the content html and call the base destructor. More... | |
 Public Member Functions inherited from pane | |
| 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... | |
Detailed Description
Insert raw html into a pane.
This is useful for static content that can be saved directly into a layout file. Ideally the html would not be huge. CSS will need to be added as a <style> tag or inserted inline as style attributes on elements.
Constructor & Destructor Documentation
◆ staticHtml()
| staticHtml | ( | layout | ) |
- Parameters
-
layout The layout for this pane
The content attribute of the layout will be appended to the DOM as html.
Member Function Documentation
◆ applyDiff()
| applyDiff | ( | diff, | |
| user | |||
| ) |
Apply a diff to this pane.
- Parameters
-
diff The incoming diff user The user who issued the diff
The only attribute that can be received is content.
◆ applySettings()
| applySettings | ( | settings | ) |
- Parameters
-
settings
DOCME
◆ attach()
| attach | ( | ) |
This node has been attached to the DOM.
Triggers a paneLoadStart and paneLoadComplete.
◆ createHTML()
| createHTML | ( | ) |
Create the html representation of this pane, and store that DOM element as this._html.
- Returns
this._html, which is a jQuery object. It will be created if needed.
One should always call the base class pane.prototype.createHTML.call(this,boolHeader) as well as use if (this._html) return this._html; as a first line.
◆ destroy()
| destroy | ( | ) |
Destroy the content html and call the base destructor.
The documentation for this class was generated from the following file:
