paneManager Class Reference

The paneManager manages panes in a user layout. More...

#include "remoto!stdlib:js/paneManager/paneManager.js"

Public Member Functions
	paneManager ()
	DOCME. More...
	applyDiff (diff, user)
	applyLayout (_layout)
	Apply a json layout, building and destroying children as needed. More...
	applySubscription (data, metadata)
	buildLayout (_layout)
	fetchPane (c, o)
	Find a pane by path/id, and return it, or create a new pane. More...
	findPane (c)
	Find a pane by path/id, and return it, or return null. More...
	garbageCollect ()
	garbge collect (destroy) any unmounted cells More...
	initialize ()
	DOCME. More...
	objectDestroy (pane)
	objectFactory (layout)
	openApplicationLayout (event, context, template, metadata)
	openModal (path, title, size, context)
	openModalForm (path, form, title, size, context, metadata)
	pathAddedCallback ()
	DOCME. More...
	pathCreateCallback ()
	A callback to use for creating new entries in the VFS based on a path. More...
	pathDeleteCallback ()
	A callback to use for deleting entries in the VFS based on a path. More...
	pathList ()
	pathRemovedCallback ()
	DOCME. More...
	pathSubmitCallback ()
	DOCME. More...
	registerPane (p)
	Register a pane in the paneManager registry, and also add it to the objectRegistry. More...
	reset ()
	DOCME. More...
	resize ()
	DOCME. More...
	saveCallback ()
	DOCME. More...
	saveLayout ()
	singlePaneLayout (layout, borderless)
	toggleSinglePane (e, nosave)
	toggleSinglePaneBorderless (e, nosave)
	unregisterPane (p)

Getters & Setters
setter	config
	a setter DOCME More...

Detailed Description

The paneManager manages panes in a user layout.

DOCME

Todo:

remove _primaryCell and _currentPane and _singlePane* and _nonSingleLayout

Constructor & Destructor Documentation

paneManager()

paneManager

(

)

DOCME.

Member Function Documentation

applyDiff()

applyDiff	(		diff,
			user
	)

Parameters

diff	The layout to apply
user	The user who made a change, which is unused

applyLayout()

applyLayout

(

_layout

)

Apply a json layout, building and destroying children as needed.

Parameters

_layout

DOCME

applySubscription()

applySubscription	(		data,
			metadata
	)

Parameters

data	The layout to apply
metadata	Unused metadata

buildLayout()

buildLayout

(

_layout

)

Parameters

_layout

Returns

DOCME

config()

getter config

a setter DOCME

a getter DOCME

fetchPane()

fetchPane	(		c,
			o
	)

Find a pane by path/id, and return it, or create a new pane.

Parameters

c	The layout of the pane to fetch
o	The object to pass to a new pane, if needed because none is found

Returns

A new paneManager::pane instance

Panes are identified by id, which is usually a path. When layout changes happen, the paneManager builds the wrappers and populates them with panes fetched based on an identifier.

findPane()

findPane

(

c

)

Find a pane by path/id, and return it, or return null.

Parameters

c	The layout of the pane to fetch

Returns

The paneManager::pane instance, or null.

Panes are identified by id, which is usually a path.

This method is not for layout changes, it is for cross-pane scripting at the UI level. For instance if one pane wants to trigger a button on another pane.

garbageCollect()

garbageCollect

(

)

garbge collect (destroy) any unmounted cells

If the layout changes in such a way that created panes have been left out of the current layout, they will be destroyed here.

initialize()

initialize

(

)

DOCME.

objectDestroy()

objectDestroy

(

pane

)

Parameters

pane

DOCME

objectFactory()

objectFactory

(

layout

)

Parameters

layout

DOCME

openApplicationLayout()

openApplicationLayout	(		event,
			context,
			template,
			metadata
	)

Parameters

event
context
template
metadata

Returns

DOCME

openModal()

openModal	(		path,
			title,
			size,
			context
	)

Parameters

path
title
size
context	DOCME - note the "expand" option for size.height

openModalForm()

openModalForm	(		path,
			form,
			title,
			size,
			context,
			metadata
	)

Parameters

path
form
title
size
context
metadata	DOCME - note the "expand" option for size.height

pathAddedCallback()

pathAddedCallback

(

)

DOCME.

pathCreateCallback()

pathCreateCallback

(

)

A callback to use for creating new entries in the VFS based on a path.

This will be set by the vfsClient instance, as it is null by default.

The form of the expected function is:

function pathCreate( c )
{
   //c is an object of paths to create:
   //c = {
   //      'path/to/new/entry': {
   //                      'alpha': 'beta',
   //                      'gamma': 'delta'
   //              },
   //      'path/to/another/new/entry': {
   //                      'whiskkey': 'tango',
   //                      'foxtrot': 'edward'
   //              },
   //};
}

Where multiple new entries can be created in one call.

See also

vfsClient::postCreate()

pathDeleteCallback()

pathDeleteCallback

(

)

A callback to use for deleting entries in the VFS based on a path.

This will be set by the vfsClient instance, as it is null by default.

The form of the expected function is:

function pathDelete( c )
{
   //c is an object of paths to delete:
   //c = {
   //      'path/to/delete/entry': true
   //      },
   //};
}

Where multiple new entries can be deleted in one call. The values must be set to true

See also

vfsClient::postDelete()

pathList()

pathList

(

)

Returns

DOCME

pathRemovedCallback()

pathRemovedCallback

(

)

DOCME.

pathSubmitCallback()

pathSubmitCallback

(

)

DOCME.

registerPane()

registerPane

(

p

)

Register a pane in the paneManager registry, and also add it to the objectRegistry.

Parameters

p	The pane object to register

reset()

reset

(

)

DOCME.

resize()

resize

(

)

DOCME.

saveCallback()

saveCallback

(

)

DOCME.

saveLayout()

saveLayout

(

)

Returns

The new layout, so other actions can be chained if needed.

DOCME

singlePaneLayout()

singlePaneLayout	(		layout,
			borderless
	)

Parameters

layout
borderless

Returns

DOCME

toggleSinglePane()

toggleSinglePane	(		e,
			nosave
	)

Parameters

e
nosave	DOCME

toggleSinglePaneBorderless()

toggleSinglePaneBorderless	(		e,
			nosave
	)

Parameters

e
nosave	DOCME

unregisterPane()

unregisterPane

(

p

)

Parameters

p

DOCME

---

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

• paneManager.js