vegui. tabbeddialog. class.js
Constants
VUI_TABBEDDIALOG	vegUI element type for VegUITabbedDialog
VUI_TAB	vegUI element type for VegUITab
VegUITabbedDialog	The tabbed dialog widget that allows to cram lots of content into little space.
Hierarchy	extends VegUINode
Type	VUI_TABBEDDIALOG
Dependencies
Child Elements
Tutorials	http://www.vegui.org- /site- /blog- /25- /vegui-tutorial-14---the-tabbed-dialog-widget.html
Properties
Object Properties
Template Properties
Functions
VegUITabbedDialog	constructor
add_tab	Adds a tab to the tabbeddialog.
build_tabdlg	Builds the tabbed dialog
set_tabdlg	Sets the most common template properties of the tabbeddialog
VegUITab	A tab in VegUITabbedDialog
Hierarchy	extends VegUINode
Type	VUI_TAB
Requires
Child Elements
Tutorials	http://www.vegui.org- /site- /blog- /25- /vegui-tutorial-14---the-tabbed-dialog-widget.html
Properties
Object properties
Template properties
Functions
VegUITab	constructor
build_tab	Builds the tab
focus	Gives focus to this tab bringing it to the foreground and moving the tabs in this.Tabs to the background
set_tab	sets the most common template properties of the tab

Constants

VUI_TABBEDDIALOG

vegUI element type for VegUITabbedDialog

VUI_TAB

vegUI element type for VegUITab

VegUITabbedDialog

The tabbed dialog widget that allows to cram lots of content into little space.

Summary

Hierarchy	extends VegUINode
Type	VUI_TABBEDDIALOG
Dependencies
Child Elements
Tutorials	http://www.vegui.org- /site- /blog- /25- /vegui-tutorial-14---the-tabbed-dialog-widget.html
Properties
Object Properties
Template Properties
Functions
VegUITabbedDialog	constructor
add_tab	Adds a tab to the tabbeddialog.
build_tabdlg	Builds the tabbed dialog
set_tabdlg	Sets the most common template properties of the tabbeddialog

Hierarchy

extends VegUINode

Inherits all properties and methods from VegUINode

VegUINode
   |
   +--> VegUITabbedDialog

Type

VUI_TABBEDDIALOG

Dependencies

file	vegui.button.class.js

Child Elements

TplTab

VegUITab, template tab all tabs will be cloned from this one

Tutorials

http://www.vegui.org- /site- /blog- /25- /vegui-tutorial-14---the-tabbed-dialog-widget.html

Properties

Object Properties

tabSpacing	int, space between each tab (pixels)
Tabs	object, holds created tabs by their child name
tabNum	int, holds the number of created tabs
tabW	int, holds the default tab width

Template Properties

T.tabSpacing

tabSpacing

Functions

VegUITabbedDialog

function VegUITabbedDialog( refName,
Parent,
Manager )

constructor

See Parent

VegUINode::VegUINode

add_tab

this.add_tab = function( tabName,
tabCaption,
tabW )

Adds a tab to the tabbeddialog. This is a template function and must be called before the tabbeddialog is built. Add tabs after building is currently not supported

Parameters

string tabName	unique name of the tab
string tabCaption	caption text in the tab
int tabW	width of the tab (pixels)

Returns

VegUITab

the created tab

Example

myTabDlg.add_tab('movies', 'Movies', 150);
myTabDlg.add_tab('music', 'Music', 150);
Manager.build_element(myTabDlg);

build_tabdlg

this.build = this.build_tabdlg = function( toNode )

Builds the tabbed dialog

private function

You should always use VegUIManager::build_element to build vegUI elements

Alias

build()

Parameters

if submitted the created html node will be appended to toNode

Returns

null	on failure
int	1 on success

See Parent

VegUINode::build_node

set_tabdlg

this.set = this.set_tabdlg = function( w,
h,
x,
y,
tabSpacing )

Sets the most common template properties of the tabbeddialog

Alias

set()

Parameters

int w	width (pixels)
int h	height (pixels)
int x	x position (pixels)
int y	y position (pixels)
int tabSpacing	space between two tabs (pixels)

See parent

VegUINode::set_node

VegUITab

A tab in VegUITabbedDialog

Summary

Hierarchy	extends VegUINode
Type	VUI_TAB
Requires
Child Elements
Tutorials	http://www.vegui.org- /site- /blog- /25- /vegui-tutorial-14---the-tabbed-dialog-widget.html
Properties
Object properties
Template properties
Functions
VegUITab	constructor
build_tab	Builds the tab
focus	Gives focus to this tab bringing it to the foreground and moving the tabs in this.Tabs to the background
set_tab	sets the most common template properties of the tab

Hierarchy

extends VegUINode

Inherits all properties and methods from VegUINode

VegUINode
   |
   +--> VegUITab

Type

VUI_TAB

Requires

file	vegui.button.class.js

Child Elements

Tab	VegUIButton, The tab
TabCaption	VegUINode, holds the caption of the tab
Panel	VegUINode, The background of the tab

Tutorials

http://www.vegui.org- /site- /blog- /25- /vegui-tutorial-14---the-tabbed-dialog-widget.html

Properties

Object properties

tabCaption	string text of TabCaption
tabSelOff	int offset of the focused tab on the y axis (pixels)
Tabs	Array tabs that are on the same tabbed dialog control as this tab

Template properties

T.tabCapion	tabCaption
T.tabSelOff	tabSelOff
T.tabW	width of the tab button
T.tabX	position of the tab button on the x axis

Functions

VegUITab

function VegUITab( refName,
Parent,
Manager )

constructor

See Parent

VegUINode::VegUINode

build_tab

this.build = this.build_tab = function( toNode )

Builds the tab

Alias

build()

Parameters

if submitted the created html node will be appended to toNode

Returns

int	1 on success
null	on failure

See Parent

VegUINode::build_node

focus

this.focus = function()

Gives focus to this tab bringing it to the foreground and moving the tabs in this.Tabs to the background

Example

myTabDlg.Tabs['music'].focus();

set_tab

this.set = this.set_tab = function( w,
h,
x,
y,
tabW,
tabX,
tabCaption,
tabSelOff )

sets the most common template properties of the tab

Alias

set()

Parameters

int w	width (pixels)
int h	height (pixels)
int x	x position (pixels)
int y	y position (pixels)
int tabW	width of the tab button (this.Tab) (pixels)
int tabX	x position of the tab button (this.Tab) (pixels)
string tabCaption	caption of this tab
int tabSelOff	y offset when tab is focused (pixels)

See Parent

VegUINode::set_node

The tabbed dialog widget that allows to cram lots of content into little space.

A tab in VegUITabbedDialog

vegUI element type for VegUITabbedDialog

function VegUITabbedDialog( refName,
Parent,
Manager )

constructor

this.add_tab = function( tabName,
tabCaption,
tabW )

Adds a tab to the tabbeddialog.

this.build = this.build_tabdlg = function( toNode )

Builds the tabbed dialog

this.set = this.set_tabdlg = function( w,
h,
x,
y,
tabSpacing )

Sets the most common template properties of the tabbeddialog

vegUI element type for VegUITab

function VegUITab( refName,
Parent,
Manager )

constructor

this.build = this.build_tab = function( toNode )

Builds the tab

this.focus = function()

Gives focus to this tab bringing it to the foreground and moving the tabs in this.Tabs to the background

this.set = this.set_tab = function( w,
h,
x,
y,
tabW,
tabX,
tabCaption,
tabSelOff )

sets the most common template properties of the tab

The most basic VegUI Element.

int, space between each tab (pixels)

function VegUINode( refName,
Parent,
Manager )

this.build_element = function( VegUIObj,
toNode )

builds a VegUIElement.

this.build = this.build_node = function( toNode,
takeNode )

build a HTML node from the template properties of this element.

this.set = this.set_node = function( nodeType,
w,
h,
x,
y,
pos,
z )

Template Function

string text of TabCaption

int offset of the focused tab on the y axis (pixels)