pane Class Reference

Create a pane which will be mounted into a paneManager layout. More...

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

Inheritance diagram for pane:

Public Member Functions
	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...

Getters & Setters
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

Create a pane which will be mounted into a paneManager layout.

The pane will want to create an object to view information, which will want to be a subclass of pane().

Constructor & Destructor Documentation

pane()

pane	(		layout,
			object
	)

Parameters

layout
object	DOCME

Member Function Documentation

activate()

activate

(

)

DOCME.

applyDiff()

applyDiff	(		data,
			user
	)

Parameters

data
user	DOCME

applyReleaseLock()

applyReleaseLock

(

data

)

Parameters

data

DOCME

applyRequestError()

applyRequestError	(		command,
			id,
			reason
	)

Parameters

command
id
reason	DOCME

applyRequestLock()

applyRequestLock

(

data

)

Parameters

data

DOCME

applyRequestSuccess()

applyRequestSuccess	(		command,
			id,
			data,
			metadata
	)

Parameters

command
id
data
metadata	DOCME

applySettings()

applySettings

(

settings

)

Parameters

settings

DOCME

applySubscription()

applySubscription	(		data,
			metadata
	)

Parameters

data
metadata	DOCME

area()

area

(

)

Returns

DOCME

attach()

attach

(

)

Provides an opportunity for a pane to pass an attach command to its object.

Note that this does not append this._html, it only calls this._object.attach().

attached()

attached

(

)

Detects is this pane is attached to the DOM.

Returns

True if this._html is attached to the DOM.

createHTML()

createHTML

(

)

Returns

DOCME

deactivate()

deactivate

(

)

If a deactivate method is present on this pane's _object, call it.

destroy()

destroy

(

)

DOCME.

detach()

detach

(

)

Detach this._html and call this._object.detach().

find()

find	(		p,
			type
	)

Parameters

p
type

Returns

DOCME

hasHelp()

hasHelp

(

)

Returns

DOCME

help()

getter help

A getter that will return a pane object's help message, or a default message indicating that no help is available.

See also

paneManager::pane::hasHelp()

mounted()

mounted

(

mountState

)

Notify this pane that the mounted state has changed.

This is used for remote VFS connections.

Parameters

mountState

A boolean indicating the new mount state.

paneType()

getter paneType

A getter which will calculate the pane type based on the _object, or return the default "pane".

This is helpful when a pane in the layout wants to use keepType to override the type returned from the VFS, and we want to register or unregister it, or save the layout

rename()

rename

(

name

)

Parameters

name

DOCME

resize()

resize

(

)

DOCME.

saveLayout()

saveLayout

(

)

Build the layout for this pane.

Returns

The layout

triggerCurrentPane()

triggerCurrentPane

(

)

DOCME.

---

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

• paneManager.js