A pane subclass used to display text streams like log data. More...
#include "remoto!stdlib:js/panes/panes/textStream.js"
Public Member Functions | |
| textStream (layout) | |
| activate () | |
| activate () | |
| applyDiff (diff, user) | |
| applyDiff (diff, user) | |
| applySettings (settings) | |
| applySettings (settings) | |
| createColor (o) | |
| Create a new random color based on some HSV values to tag a log line identifier. More... | |
| createHTML () | |
| Create the HTML contents of the pane. More... | |
| createHTML () | |
| Create the HTML contents of the pane. More... | |
| destroy () | |
| destroy () | |
| formatDate () | |
| Format the date of a line based on the _dateFormat setting. More... | |
| levelLimit () | |
| Update the textStream to only reveal lines whose limit is >= this._logLevel. More... | |
| lineLevelLimit () | |
| Hide/show and truncate the lines in the stream to match the current settings. More... | |
| lineLimit () | |
| Truncate the number of lines in the stream to the limit. More... | |
| resize () | |
| Does nothing. More... | |
| resize () | |
| Does nothing. More... | |
| scrollTail () | |
| Scroll to the bottom of the text stream, but only if _tail is set. More... | |
| update (dirty) | |
| Process the _queue and apply the settings. More... | |
| update (dirty) | |
| Process the _queue and apply the settings. More... | |
| updateUserFilter () | |
| Update the list of users available to filter on, based on the static global list. 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
A pane subclass used to display text streams like log data.
DOCME
Constructor & Destructor Documentation
◆ textStream()
| textStream | ( | layout | ) |
- Parameters
-
layout
DOCME
Member Function Documentation
◆ activate() [1/2]
| activate | ( | ) |
DOCME
◆ activate() [2/2]
| activate | ( | ) |
DOCME
◆ applyDiff() [1/2]
| applyDiff | ( | diff, | |
| user | |||
| ) |
- Parameters
-
diff user
DOCME
◆ applyDiff() [2/2]
| applyDiff | ( | diff, | |
| user | |||
| ) |
- Parameters
-
diff user
DOCME
◆ applySettings() [1/2]
| applySettings | ( | settings | ) |
- Parameters
-
settings
DOCME
◆ applySettings() [2/2]
| applySettings | ( | settings | ) |
- Parameters
-
settings
DOCME
◆ createColor()
| createColor | ( | o | ) |
Create a new random color based on some HSV values to tag a log line identifier.
- Parameters
-
o The name to assign the color
- Returns
- The new color string as a hex value, with a prepended '#'
This will return a new color of any hue with a saturaton of 1.0 and a value of 0.5. This new color will be added to the static global textStream.colors object.
- See also
- color.randomHSV()
◆ createHTML() [1/2]
| createHTML | ( | ) |
Create the HTML contents of the pane.
- Returns
- the root of the jquery html contents
DOCME
◆ createHTML() [2/2]
| createHTML | ( | ) |
Create the HTML contents of the pane.
- Returns
- the root of the jquery html contents
DOCME
◆ destroy() [1/2]
| destroy | ( | ) |
DOCME
◆ destroy() [2/2]
| destroy | ( | ) |
DOCME
◆ formatDate()
| formatDate | ( | ) |
Format the date of a line based on the _dateFormat setting.
◆ levelLimit()
| levelLimit | ( | ) |
Update the textStream to only reveal lines whose limit is >= this._logLevel.
◆ lineLevelLimit()
| lineLevelLimit | ( | ) |
Hide/show and truncate the lines in the stream to match the current settings.
This is the optimized hybrid of lineLimit() and levelLimit().
◆ lineLimit()
| lineLimit | ( | ) |
Truncate the number of lines in the stream to the limit.
◆ resize() [1/2]
| resize | ( | ) |
Does nothing.
This method is included as a place holder for future use.
◆ resize() [2/2]
| resize | ( | ) |
Does nothing.
This method is included as a place holder for future use.
◆ scrollTail()
| scrollTail | ( | ) |
Scroll to the bottom of the text stream, but only if _tail is set.
◆ update() [1/2]
| update | ( | dirty | ) |
Process the _queue and apply the settings.
- Parameters
-
dirty boolean value, forcibly mark this as dirty and needing an update
◆ update() [2/2]
| update | ( | dirty | ) |
Process the _queue and apply the settings.
- Parameters
-
dirty boolean value, forcibly mark this as dirty and needing an update
◆ updateUserFilter()
| updateUserFilter | ( | ) |
Update the list of users available to filter on, based on the static global list.
Uses the textStream.colors object to populate the list.
The documentation for this class was generated from the following files:
