Tabbox"

From Documentation
Line 10: Line 10:
 
= Employment/Purpose =
 
= Employment/Purpose =
  
A tabbox that contains the tabs and tabpanels allows developers to separate a large number of components into several groups(each group contains a tab and a tabpanel), and show one group each time, such that the user interface won't be too complicate to read. There is only one group (aka., a tabpanel) is visible at the same time. Once the tab of an invisible group is clicked, it becomes visible and the previous visible group becomes invisible.
+
A tabbox is a container used to display a set of tabbed groups of components. A row of tabs is displayed at the top (or left or other location) of tabbox which may be used to switch between each group. It allows developers to separate a large number of components into several groups (each group is contained in [[ZK Component Reference/Containers/Tabbox/Tabpanel|a tabpanel]]). Only one group is visible at the time, such that the user interface won't be too complicate to read. Once [[ZK Component Reference/Containers/Tabbox/Tab|the tab]] of an invisible group is clicked, it becomes visible and the previous visible group becomes invisible.
  
The currently selected tab component is given an additional selected property which is set to true. This is used to give the currently selected tab a different appearance so that it will look selected. Only one tab will have a true value for this property at a time. If none of tabs are selected, the first one is selected automatically.
+
The visible group is called ''selected'', which can be retrieved by use of <javadoc method="getSelectedPanel()">org.zkoss.zul.Tabbox</javadoc> or <javadoc method="getSelectedIndex()">org.zkoss.zul.Tabbox</javadoc>.
  
 
= Example =
 
= Example =

Revision as of 03:54, 23 December 2010

Tabbox

Employment/Purpose

A tabbox is a container used to display a set of tabbed groups of components. A row of tabs is displayed at the top (or left or other location) of tabbox which may be used to switch between each group. It allows developers to separate a large number of components into several groups (each group is contained in a tabpanel). Only one group is visible at the time, such that the user interface won't be too complicate to read. Once the tab of an invisible group is clicked, it becomes visible and the previous visible group becomes invisible.

The visible group is called selected, which can be retrieved by use of Tabbox.getSelectedPanel() or Tabbox.getSelectedIndex().

Example

ZKComRef Tabbox Examples.PNG

<zk>
	<tabbox width="400px">
		<tabs>
			<tab label="Tab 1" />
			<tab label="Tab 2" />
		</tabs>
		<tabpanels>
			<tabpanel>This is panel 1</tabpanel>
			<tabpanel>This is panel 2</tabpanel>
		</tabpanels>
	</tabbox>
	<space />
	<tabbox width="400px" mold="accordion">
		<tabs>
			<tab label="Tab 3" />
			<tab label="Tab 4" />
		</tabs>
		<tabpanels>
			<tabpanel>This is panel 3</tabpanel>
			<tabpanel>This is panel 4</tabpanel>
		</tabpanels>
	</tabbox>
</zk>

Toolbar Component

The Tabbox supports the inclusion of other controls within its tab bar, thus allowing more freedom and layout options when creating layouts which include a Tabbox. The screenshot below demonstrates an example Tabbox which includes extra controls in the tab bar acting like a menu system.

ZKComRef Tabbox Toolbar Examples.png

<tabbox width="250px">
	<tabs>
		<tab label="Tab 1" closable="true" />
		<tab label="Tab 2" closable="true" />
		<tab label="Tab 3" closable="true" />
		<tab label="Tab 4" closable="true" />
		<tab label="Tab 5" closable="true" />
	</tabs>
	<toolbar>
		<toolbarbutton image="/img/live.gif" onClick='alert("Live")' />
		<toolbarbutton image="/img/defender.gif"
			onClick='alert("Defender")' />
		<toolbarbutton image="/img/battery.gif"
			onClick='alert("Battery")' />
	</toolbar>
	<tabpanels>
		<tabpanel>This is panel 1</tabpanel>
		<tabpanel>This is panel 2 The second panel</tabpanel>
		<tabpanel>This is panel 3</tabpanel>
		<tabpanel>This is panel 4</tabpanel>
		<tabpanel>This is panel 5</tabpanel>
	</tabpanels>
</tabbox>

Supported Events

Name
Event Type
onSelect
Event: SelectEvent


Denotes user has selected a tab. onSelect is sent to both tab and tabbox.

Supported Molds

Available molds of a component are defined in lang.xml embedded in zul.jar.

Name
Snapshot
default
Tabbox mold default.png
accordion
Tabbox mold accordion.png
accordion-lite
Tabbox mold accordion-lite.png

Supported Children

* Tabs,  Tabpanels

Use Cases

Version Description Example Location
5.0 Tabbox can be used to display information on seperate panels and show only one panel a time. http://www.zkoss.org/zkdemo/userguide/#l10

Version History

Last Update : 2010/12/23


Version Date Content
     



Last Update : 2010/12/23

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.