paneTransitioner Class Reference

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"

Inheritance diagram for paneTransitioner:

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)
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...

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...

Detailed Description

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.

See also

paneTransitioner::transitionTypes

Definition at line 4 of file paneTransitioner.h.

Member Enumeration Documentation

transitionTypes

enum paneTransitioner::transitionTypes

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 pane
  • start - 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.

Enumerator
dissolve	A basic dissolve transition, equivalent to a crossfade.
dipToBlack	Initial content will fade to transparent, and then incoming content will fade to opaque. The fades to/from transparency will be half of the total duration
venetian	Transition as if venetian blinds are opening. This is an example for using css masks.
crosszoom	Zoom and crossfade between panes. This an example of css transforms
softwipeRtoL	Wipe from right to left with a soft faded edge. This is useful almost as a page turn between panes
softwipeLtoR	Wipe from left to right with a soft faded edge. This is useful almost as a page turn between panes, with a feel of going backward.

Definition at line 6 of file paneTransitioner.h.

Constructor & Destructor Documentation

paneTransitioner()

paneTransitioner

(

layout

)

Construct a paneTransitioner.

Parameters

layout

The layout object

DOCME

Member Function Documentation

applyDiff()

applyDiff	(		diff,
			user
	)

Parameters

diff
user

DOCME

applySettings()

applySettings

(

settings

)

Parameters

settings

DOCME

applySubscription()

applySubscription	(		data,
			metadata
	)

Parameters

data
metadata

Returns

DOCME

attach()

attach

(

)

attach this paneTransitioner to the paneManager, and any panes that are currently registered.

background()

setter background

Set the background css of this pane.

createHTML()

createHTML

(

)

Returns

DOCME

createPane()

createPane

(

path

)

Create a pane based on path.

Parameters

path	The path to create

destroy()

destroy

(

)

DOCME

detach()

detach

(

)

detach this paneTransitioner and any panes that are registered

DOCME

duration()

setter duration

a setter DOCME

getPane()

getPane	(		path,
			activate
	)

Check the keepAlive cache or create a new pane.

Parameters

path	The path to get or create
activate	Bool to activate the pane

getStateIndex()

getStateIndex

(

s

)

Get the index of a path from the states list.

Parameters

s	The path to look for

Returns

The index of the path, or -1 if not found

This is used for slideshows to find a next item.

hideCursorFullscreen()

setter hideCursorFullscreen

a setter DOCME

incrementState()

incrementState

(

)

DOCME

keepAlive()

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.

preload()

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()

resetSleepTimer

(

)

DOCME

resize()

resize

(

)

DOCME

sleep()

setter sleep

a setter DOCME

sleepNow()

sleepNow

(

)

DOCME

sleepTo()

setter sleepTo

a setter DOCME

slideshow()

setter slideshow

a setter DOCME

slideshowSpeed()

setter slideshowSpeed

a setter DOCME

state()

setter state

a setter DOCME

transition()

setter transition

a setter DOCME

transitionComplete()

transitionComplete

(

evt

)

Parameters

evt

DOCME

---

The documentation for this class was generated from the following files:

• paneTransitioner.h
• paneTransitioner.js