tabswitcher Class Reference

A tabbed layout element, intended to be used at the top of the applications UI. More...

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

Public Member Functions
	tabswitcher (layout)
	Create a tabswitcher object based on layout parameters. More...
	activate ()
	DOCME. More...
	addTab (n, c)
	addTabPrompt (e)
	attach ()
	Attach the tabs's children. More...
	closeAllTabs ()
	Close all open tabs. More...
	closeCurrentTab ()
	DOCME. More...
	closeTab ()
	DOCME. More...
	containsTabsOtherThan (t)
	createChildren (children)
	createHTML ()
	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)
	openMenu (e)
	removeTab (e)
	renameTab (e)
	replaceChild (oldChild, newChild)
	resize ()
	DOCME. More...
	saveLayout ()
	Save the state of this tabswitcher. More...
	selectTabHandler (p, e)
	triggerCurrentPane ()
	DOCME. More...

Detailed Description

A tabbed layout element, intended to be used at the top of the applications UI.

Constructor & Destructor Documentation

tabswitcher()

tabswitcher

(

layout

)

Create a tabswitcher object based on layout parameters.

Parameters

layout

The json layout definition

Layout options include:

• name : The _name of this 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 in an array

Member Function Documentation

activate()

activate

(

)

DOCME.

addTab()

addTab	(		n,
			c
	)

Parameters

n
c	DOCME

addTabPrompt()

addTabPrompt

(

e

)

Parameters

e

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.

containsTabsOtherThan()

containsTabsOtherThan

(

t

)

Parameters

t

Returns

DOCME

createChildren()

createChildren

(

children

)

Parameters

children

Returns

DOCME

createHTML()

createHTML

(

)

Returns

DOCME

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

openMenu()

openMenu

(

e

)

Parameters

e

DOCME

removeTab()

removeTab

(

e

)

Parameters

e

Returns

DOCME

renameTab()

renameTab

(

e

)

Parameters

e

DOCME

replaceChild()

replaceChild	(		oldChild,
			newChild
	)

Parameters

oldChild
newChild

Returns

DOCME

resize()

resize

(

)

DOCME.

saveLayout()

saveLayout

(

)

Save the state of this tabswitcher.

Returns

The JSON value to be added to a layout file

The object returned will include:

• name : The _name of this 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.
• title : A tooltip that will appear when presented in another tab
• children : The value of each child's saveLayout() response.

selectTabHandler()

selectTabHandler	(		p,
			e
	)

Parameters

p
e	DOCME

triggerCurrentPane()

triggerCurrentPane

(

)

DOCME.

---

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

• paneManager.js