zul.tab
Class Tabbox

java.lang.Object
  zk.Object
      zk.Widget
          zul.Widget
              zul.tab.Tabbox

public class Tabbox
extends Widget

A tabbox.

Event:

1. onSelect is sent when user changes the tab.

Mold:

default

The default tabbox.

accordion

The accordion tabbox.

Toolbar only works in the horizontal default mold and the isTabscroll() to be true.

Default Widget.getZclass(): z-tabbox.

Field Summary

Fields inherited from class zk.Widget

$weave, auDelay, autag, bindLevel, className, desktop, effects_, firstChild, id, insertingBefore_, inServer, lastChild, nChildren, nextSibling, parent, previousSibling, uuid, widgetName

Fields inherited from class zk.Object

$class, $oid

Method Summary

String	getOrient() Returns the orient.
String	getPanelSpacing() Returns the spacing between Tabpanel.
int	getSelectedIndex() Returns the selected index.
Tabpanel	getSelectedPanel() Returns the selected tab panel.
Tab	getSelectedTab() Returns the selected tab.
Tabpanels	getTabpanels() Returns the tabpanels that this tabbox owns.
Tabs	getTabs() Returns the tabs that this tabbox owns.
Toolbar	getToolbar() Returns the auxiliary toolbar that this tabbox owns.
boolean	inAccordionMold() Returns whether it is in the accordion mold.
boolean	isBottom() Returns whether it is the bottom orientation.
boolean	isHorizontal() Returns whether it is a horizontal tabbox.
boolean	isLeft() Returns whether it is the left orientation.
boolean	isMaximalHeight() Returns whether to use maximum height of all tabpanel in initial phase or not.
boolean	isRight() Returns whether it is the right orientation.
boolean	isTabscroll() Returns whether the tab scrolling is enabled.
boolean	isTop() Returns whether it is the top orientation.
boolean	isVertical() Returns whether it is a vertical tabbox.
void	setMaximalHeight(boolean maximalHeight) Sets whether to use maximum height of all tabpanel in initial phase or not.
void	setOrient(String orient) Sets the orient.
void	setPanelSpacing(String panelSpacing) Sets the spacing between Tabpanel.
void	setSelectedIndex(int index) Sets the selected index.
void	setSelectedPanel(Tabpanel panel) Sets the selected tab panel.
void	setSelectedTab(Tab tab) Sets the selected tab.
void	setTabscroll(boolean tabscroll) Sets whether to eable the tab scrolling
void	syncSize() Synchronizes the size immediately.

Methods inherited from class zul.Widget

afterKeyDown_, beforeCtrlKeys_, getContext, getCtrlKeys, getOpenTooltip, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from class zk.Widget

$, $f, $f, $f, $init, $n, $n, $o, $s, afterAnima_, afterParentChanged_, appendChild, appendChild, beforeParentChanged_, beforeSendAU_, bind_, bind, bindChildren_, bindDoubleTap_, bindSwipe_, bindTapHold_, canActivate, cleanDrag_, clear, clearCache, cloneDrag_, deferRedraw_, deferRedrawHTML_, detach, doBlur_, doClick_, doDoubleClick_, doFocus_, doKeyDown_, doKeyPress_, doKeyUp_, domAttrs_, domClass_, domListen_, doMouseDown_, doMouseEnter_, doMouseLeave_, doMouseMove_, doMouseOut_, doMouseOver_, doMouseUp_, domStyle_, domTextStyleAttr_, domTooltiptext_, domUnlisten_, doResizeScroll_, doRightClick_, doSelect_, doSwipe_, doTooltipOut_, doTooltipOver_, dropEffect_, extraBind_, fire, fireX, focus_, focus, forcerender, fromPageCoord, get, getAction, getCaveNode, getChildAt, getChildIndex, getClass, getDraggable, getDragMessage_, getDragNode, getDragOptions_, getDrop_, getDroppable, getElementsById, getElementsByName, getFirstNode_, getFloatZIndex_, getHeight, getHflex, getId, getLeft, getMold, getOldWidget_, getPage, getRenderdefer, getSclass, getScrollLeft, getScrollTop, getStyle, getTextNode, getTooltiptext, getTop, getTopWidget, getVflex, getWidth, getZclass, getZIndex, hide, ignoreDescendantFloatUp_, ignoreDrag_, initDrag_, insertBefore, insertChildHTML_, isAutoId, isBinding, isFloating_, isListen, isRealElement, isRealVisible, isRealVisible, isVisible, isVisible, isWatchable_, listen, listenOnFitSize_, mimicMouseDown_, newInstance, nextUuid, onAfterSize, onChildAdded_, onChildRemoved_, onChildRenderDefer_, onChildReplaced_, onChildVisible_, onDrop_, redraw, redrawHTML_, register, removeChild, removeChild, removeChildHTML_, removeHTML_, replaceCavedChildren_, replaceChildHTML_, replaceHTML, replaceWidget, rerender, rerender, scrollIntoView, sendAU_, set, set, setAction, setChildren, setDomVisible_, setDraggable, setDroppable, setFloating_, setFloatZIndex_, setHeight, setHflex, setId, setLeft, setListener, setListener, setListeners, setMold, setRenderdefer, setSclass, setScrollLeft, setScrollTop, setStyle, setTooltiptext, setTop, setTopmost, setVflex, setVisible, setWidth, setZclass, setZIndex, shallChildROD_, shallIgnoreClick_, show, smartUpdate, unbind_, unbind, unbindChildren_, unbindDoubleTap_, unbindSwipe_, unbindTapHold_, uncloneDrag_, unlisten, unlistenOnFitSize_, updateDomClass_, updateDomStyle_, uuid, zsync

Methods inherited from class zk.Object

$init, $instanceof, $super, $super, $supers, $supers, afterInit, isAssignableFrom, isInstance, proxy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setTabscroll

public void setTabscroll(boolean tabscroll)

Sets whether to eable the tab scrolling

Parameters:

tabscroll -

isTabscroll

public boolean isTabscroll()

Returns whether the tab scrolling is enabled. Default: true.

Returns:

boolean

setOrient

public void setOrient(String orient)

Sets the orient.

Parameters:

orient - either "top", "left", "bottom or "right".

Since:

7.0.0 "horizontal" is renamed to "top" and "vertical" is renamed to "left".

getOrient

public String getOrient()

Returns the orient.

Default: "top".

Note: only the default mold supports it (not supported if accordion).

Returns:

String

setMaximalHeight

public void setMaximalHeight(boolean maximalHeight)

Sets whether to use maximum height of all tabpanel in initial phase or not.

The Client ROD feature will be disabled if it is set to true.

Parameters:

maximalHeight -

Since:

7.0.0

isMaximalHeight

public boolean isMaximalHeight()

Returns whether to use maximum height of all tabpanel in initial phase or not.

Default: false.

Returns:

boolean

Since:

7.0.0

setPanelSpacing

public void setPanelSpacing(String panelSpacing)

Sets the spacing between Tabpanel. This is used by certain molds, such as accordion.

Parameters:

panelSpacing -

getPanelSpacing

public String getPanelSpacing()

Returns the spacing between Tabpanel. This is used by certain molds, such as accordion.

Default: null (no spacing).

Returns:

String

getTabs

public Tabs getTabs()

Returns the tabs that this tabbox owns.

Returns:

Tabs

getTabpanels

public Tabpanels getTabpanels()

Returns the tabpanels that this tabbox owns.

Returns:

Tabpanels

getToolbar

public Toolbar getToolbar()

Returns the auxiliary toolbar that this tabbox owns.

Returns:

zul.wgt.Toolbar

isHorizontal

public boolean isHorizontal()

Returns whether it is a horizontal tabbox.

Returns:

boolean

isTop

public boolean isTop()

Returns whether it is the top orientation.

Returns:

boolean

isBottom

public boolean isBottom()

Returns whether it is the bottom orientation.

Returns:

boolean

isVertical

public boolean isVertical()

Returns whether it is a vertical tabbox.

Returns:

boolean

isRight

public boolean isRight()

Returns whether it is the right orientation.

Returns:

boolean

isLeft

public boolean isLeft()

Returns whether it is the left orientation.

Returns:

boolean

inAccordionMold

public boolean inAccordionMold()

Returns whether it is in the accordion mold.

Returns:

boolean

getSelectedIndex

public int getSelectedIndex()

Returns the selected index.

Returns:

int

setSelectedIndex

public void setSelectedIndex(int index)

Sets the selected index.

Parameters:

index -

getSelectedPanel

public Tabpanel getSelectedPanel()

Returns the selected tab panel.

Returns:

Tabpanel

setSelectedPanel

public void setSelectedPanel(Tabpanel panel)

Sets the selected tab panel.

Parameters:

panel -

getSelectedTab

public Tab getSelectedTab()

Returns the selected tab.

Returns:

Tab

setSelectedTab

public void setSelectedTab(Tab tab)

Sets the selected tab.

Parameters:

tab -

syncSize

public void syncSize()

Synchronizes the size immediately. This method is called automatically if the widget is created at the server (i.e., Widget.inServer is true). You have to invoke this method only if you create this widget at client and add or remove children from this widget.

Since:

5.0.8