tabs Class Reference

A tabbed layout element which allows splits. More...

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

Public Member Functions
	tabs (layout)
	Create a tabs object based on layout parameters. More...
	activate ()
	DOCME. More...
	appendTab (pane)
	attach ()
	Attach the tabs's children. More...
	closeAllTabs ()
	Close all open tabs. More...
	closeCurrentTab ()
	DOCME. More...
	closeTab ()
	DOCME. More...
	createChildren (children)
	createHTML ()
	createPaneByPath ()
	Create a new pane to any path. More...
	createPaneByPathHandler (path)
	Ceate a pane to any path. More...
	deactivate ()
	Deactivate this element and call deactivate on all its children. More...
	destroy ()
	DOCME. More...
	detach ()
	Detach the tab's children. More...
	find (p, type)
	hasHelp ()
	mergeable ()
	mergeSplitter ()
	DOCME. More...
	moveTab (tab, index)
	openHelp ()
	DOCME. More...
	openMenu (e)
	receiveTab (tab, index)
	removeTab (tab, moving)
	renameTab (tab, name)
	replaceChild (oldChild, newChild)
	resize ()
	DOCME. More...
	saveLayout ()
	selectTabHandler (p, e)
	splitHorizontal ()
	DOCME. More...
	splitVertical ()
	DOCME. More...
	triggerCurrentPane ()
	DOCME. More...

Detailed Description

A tabbed layout element which allows splits.

Constructor & Destructor Documentation

tabs()

tabs

(

layout

)

Create a tabs object based on layout parameters.

Parameters

layout

The json layout definition

Layout options include:

• name : The _name of this tabswitcher
• id : An identifier for this object
• uuid : A unique identifier for this object
• icon : An icon to use when placing this in a container, like another tabs or tabswitcher
• type : "tabswitcher"
• selected : The currently _selected tab
• sortable : If re-orderable tabs are disallowed
• trigger : A named trigger
• showMenu : Boolean whether to show the menu button
• tabContextMenus : If false, tabs will not respond to a context menu event (right click), and instead pass the event to the header.
• children : The layout definition for each child as an array
• additionalMenus: An array of VFS paths to subscribe to, which will create menu items

Member Function Documentation

activate()

activate

(

)

DOCME.

appendTab()

appendTab

(

pane

)

Parameters

pane

Returns

DOCME

attach()

attach

(

)

Attach the tabs's children.

Calls attach on each element in the child list. This is used for sub-layouts when a wrapping layout changes.

closeAllTabs()

closeAllTabs

(

)

Close all open tabs.

closeCurrentTab()

closeCurrentTab

(

)

DOCME.

closeTab()

closeTab

(

)

DOCME.

createChildren()

createChildren

(

children

)

Parameters

children

Returns

DOCME

createHTML()

createHTML

(

)

Returns

DOCME

createPaneByPath()

createPaneByPath

(

)

Create a new pane to any path.

This function opens a modal to receive a path.

This is hidden, and will probably be deprecated, as it's a huge security risk and the common user won't know what path to enter and the resulting pane will probably have a type and dependencies that need resolving.

createPaneByPathHandler()

createPaneByPathHandler

(

path

)

Ceate a pane to any path.

Parameters

path

This is hidden, and will probably be deprecated, as it's a huge security risk and the common user won't know what path to enter and the resulting pane will probably have a type and dependencies that need resolving.

deactivate()

deactivate

(

)

Deactivate this element and call deactivate on all its children.

destroy()

destroy

(

)

DOCME.

detach()

detach

(

)

Detach the tab's children.

Calls detach on each element in the child list.

find()

find	(		p,
			type
	)

Parameters

p
type

Returns

DOCME

hasHelp()

hasHelp

(

)

Returns

DOCME

mergeable()

mergeable

(

)

Returns

DOCME

mergeSplitter()

mergeSplitter

(

)

DOCME.

moveTab()

moveTab	(		tab,
			index
	)

Parameters

tab
index	DOCME

openHelp()

openHelp

(

)

DOCME.

openMenu()

openMenu

(

e

)

Parameters

e

DOCME

receiveTab()

receiveTab	(		tab,
			index
	)

Parameters

tab
index	DOCME

removeTab()

removeTab	(		tab,
			moving
	)

Parameters

tab
moving	DOCME

renameTab()

renameTab	(		tab,
			name
	)

Parameters

tab
name	DOCME

replaceChild()

replaceChild	(		oldChild,
			newChild
	)

Parameters

oldChild
newChild

Returns

DOCME

resize()

resize

(

)

DOCME.

saveLayout()

saveLayout

(

)

Returns

DOCME

selectTabHandler()

selectTabHandler	(		p,
			e
	)

Parameters

p
e	DOCME

splitHorizontal()

splitHorizontal

(

)

DOCME.

splitVertical()

splitVertical

(

)

DOCME.

triggerCurrentPane()

triggerCurrentPane

(

)

DOCME.

---

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

• paneManager.js