Remoto - VFS
|
The pane transition will receive a path in its state
field, and will subscribe to that path.
More...
#include "remoto!stdlib:js/panes/panes/paneTransitioner.js"
Public Member Functions | |
paneTransitioner (layout) | |
Construct a paneTransitioner. More... | |
applyDiff (diff, user) | |
applySettings (settings) | |
applySubscription (data, metadata) | |
attach () | |
attach this paneTransitioner to the paneManager, and any panes that are currently registered. More... | |
createHTML () | |
createPane (path) | |
Create a pane based on path. More... | |
destroy () | |
detach () | |
detach this paneTransitioner and any panes that are registered More... | |
getPane (path, activate) | |
Check the keepAlive cache or create a new pane. More... | |
getStateIndex (s) | |
Get the index of a path from the states list. More... | |
incrementState () | |
resetSleepTimer () | |
resize () | |
sleepNow () | |
transitionComplete (evt) | |
![]() | |
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... | |
Private Types | |
enum | transitionTypes { dissolve , dipToBlack , venetian , crosszoom , softwipeRtoL , softwipeLtoR } |
The transition types available as entries in a JSON object. More... | |
Getters & Setters | |
setter | sleep |
a setter DOCME More... | |
setter | sleepTo |
a setter DOCME More... | |
setter | duration |
a setter DOCME More... | |
setter | transition |
a setter DOCME More... | |
setter | slideshowSpeed |
a setter DOCME More... | |
setter | slideshow |
a setter DOCME More... | |
setter | state |
a setter DOCME More... | |
setter | hideCursorFullscreen |
a setter DOCME More... | |
setter | background |
Set the background css of this pane. More... | |
setter | keepAlive |
Set the keepAlive list for this pane. More... | |
setter | preload |
Set boolean preload. More... | |
The pane transition will receive a path in its state
field, and will subscribe to that path.
If a new state
is set, the paneTransitioner will smoothly subscribe to the new path, transition to that path, and destroy the previous path.
A variety of transitions are available, and additional ones can be dynamically added by writing new entries to the paneTransitioner.transitions
object.
Definition at line 4 of file paneTransitioner.h.
|
private |
The transition types available as entries in a JSON object.
A transition type definition will consist of three parts:
new
- The states for a new panestart
- The css state of the pane before it is shown, when the transition begins.end
- The css state at the end of the transition, after it is complete.complete
- The css state after transition completes, for both old and new. This should reset all attributes animated during the transition to empty: "".old
- The state to transition the current pane to during the transition. Definition at line 6 of file paneTransitioner.h.
paneTransitioner | ( | layout | ) |
applyDiff | ( | diff, | |
user | |||
) |
diff | |
user |
DOCME
applySettings | ( | settings | ) |
settings |
DOCME
applySubscription | ( | data, | |
metadata | |||
) |
data | |
metadata |
DOCME
attach | ( | ) |
attach this paneTransitioner to the paneManager, and any panes that are currently registered.
setter background |
Set the background css of this pane.
createHTML | ( | ) |
DOCME
createPane | ( | path | ) |
Create a pane based on path.
path | The path to create |
destroy | ( | ) |
DOCME
detach | ( | ) |
detach this paneTransitioner and any panes that are registered
DOCME
setter duration |
a setter DOCME
getPane | ( | path, | |
activate | |||
) |
Check the keepAlive cache or create a new pane.
path | The path to get or create |
activate | Bool to activate the pane |
getStateIndex | ( | s | ) |
Get the index of a path from the states list.
s | The path to look for |
This is used for slideshows to find a next item.
setter hideCursorFullscreen |
a setter DOCME
incrementState | ( | ) |
DOCME
getter keepAlive |
Set the keepAlive list for this pane.
Get the keepAlive path list.
If any
The keepalive list is internally saved as an object, but this getter will return the list of keys for the _keepAlive list, which are the paths.
setter preload |
Set boolean preload.
If preload is true, the list found in keepAlive
will be preloaded. If set to false, items encountered in the keepAlive list will not be destroyed when transitioned away, however they must be loaded when requested.
resetSleepTimer | ( | ) |
DOCME
resize | ( | ) |
DOCME
setter sleep |
a setter DOCME
sleepNow | ( | ) |
DOCME
setter sleepTo |
a setter DOCME
setter slideshow |
a setter DOCME
setter slideshowSpeed |
a setter DOCME
setter state |
a setter DOCME
setter transition |
a setter DOCME
transitionComplete | ( | evt | ) |
evt |
DOCME