org.zkoss.zul
Class Tabbox

java.lang.Object
  extended by org.zkoss.zk.ui.AbstractComponent
      extended by org.zkoss.zk.ui.HtmlBasedComponent
          extended by org.zkoss.zul.impl.XulElement
              extended by org.zkoss.zul.Tabbox
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl

public class Tabbox
extends XulElement

A tabbox.

Event:

  1. org.zkoss.zk.ui.event.SelectEvent 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. (since 3.6.3)

Default getZclass(): z-tabbox. (since 3.5.0)

Author:
tomyeh
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent
org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl
 
Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent
org.zkoss.zk.ui.AbstractComponent.Children
 
Field Summary
 
Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent
_zclass
 
Fields inherited from interface org.zkoss.zk.ui.Component
APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE
 
Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl
CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE
 
Constructor Summary
Tabbox()
           
 
Method Summary
 void beforeChildAdded(org.zkoss.zk.ui.Component child, org.zkoss.zk.ui.Component refChild)
           
protected  void clearSelectedTab()
           
 java.lang.Object clone()
           
 java.lang.String getOrient()
          Returns the orient.
 java.lang.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.
 java.lang.String getZclass()
           
 boolean insertBefore(org.zkoss.zk.ui.Component child, org.zkoss.zk.ui.Component refChild)
           
 boolean isHorizontal()
          Returns whether it is a horizontal tabbox.
 boolean isTabscroll()
          Returns whether the tab scrolling is enabled.
 boolean isVertical()
          Returns whether it is a vertical tabbox.
 void onChildRemoved(org.zkoss.zk.ui.Component child)
           
protected  void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
           
 void setMold(java.lang.String mold)
          Sets the mold.
 void setOrient(java.lang.String orient)
          Sets the orient.
 void setPanelSpacing(java.lang.String panelSpacing)
          Sets the spacing between Tabpanel.
 void setSelectedIndex(int j)
          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 enable the tab scrolling.
 
Methods inherited from class org.zkoss.zul.impl.XulElement
getContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip
 
Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent
focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, service, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeightDirectly, setHflex, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setTopDirectly, setVflex, setWidth, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly
 
Methods inherited from class org.zkoss.zk.ui.AbstractComponent
addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addScopeListener, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getStubonly, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setDefinition, setDefinition, setId, setPage, setPageBefore, setParent, setStubonly, setStubonly, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, willPassivate, willPassivate, willSerialize, willSerialize
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Tabbox

public Tabbox()
Method Detail

getTabs

public Tabs getTabs()
Returns the tabs that this tabbox owns.


getToolbar

public Toolbar getToolbar()
Returns the auxiliary toolbar that this tabbox owns.

Since:
3.6.3

getTabpanels

public Tabpanels getTabpanels()
Returns the tabpanels that this tabbox owns.


isTabscroll

public boolean isTabscroll()
Returns whether the tab scrolling is enabled. Default: true.

Since:
3.5.0

setTabscroll

public void setTabscroll(boolean tabscroll)
Sets whether to enable the tab scrolling. When enabled, if tab list is wider than tab bar, left, right arrow will appear.

Since:
3.5.0

getPanelSpacing

public java.lang.String getPanelSpacing()
Returns the spacing between Tabpanel. This is used by certain molds, such as accordion.

Default: null (no spacing).


setPanelSpacing

public void setPanelSpacing(java.lang.String panelSpacing)
Sets the spacing between Tabpanel. This is used by certain molds, such as accordion.


getSelectedIndex

public int getSelectedIndex()
Returns the selected index.


setSelectedIndex

public void setSelectedIndex(int j)
Sets the selected index.


getSelectedPanel

public Tabpanel getSelectedPanel()
Returns the selected tab panel.


setSelectedPanel

public void setSelectedPanel(Tabpanel panel)
Sets the selected tab panel.


getSelectedTab

public Tab getSelectedTab()
Returns the selected tab.


setSelectedTab

public void setSelectedTab(Tab tab)
Sets the selected tab.


getOrient

public java.lang.String getOrient()
Returns the orient.

Default: "horizontal".

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


setMold

public void setMold(java.lang.String mold)
Sets the mold.

Specified by:
setMold in interface org.zkoss.zk.ui.Component
Overrides:
setMold in class org.zkoss.zk.ui.AbstractComponent
Parameters:
mold - default , accordion and accordion-lite

setOrient

public void setOrient(java.lang.String orient)
               throws org.zkoss.zk.ui.WrongValueException
Sets the orient.

Parameters:
orient - either "horizontal" or "vertical".
Throws:
org.zkoss.zk.ui.WrongValueException

isHorizontal

public boolean isHorizontal()
Returns whether it is a horizontal tabbox.

Since:
3.0.3

isVertical

public boolean isVertical()
Returns whether it is a vertical tabbox.

Since:
3.0.3

getZclass

public java.lang.String getZclass()
Overrides:
getZclass in class org.zkoss.zk.ui.HtmlBasedComponent

beforeChildAdded

public void beforeChildAdded(org.zkoss.zk.ui.Component child,
                             org.zkoss.zk.ui.Component refChild)
Specified by:
beforeChildAdded in interface org.zkoss.zk.ui.sys.ComponentCtrl
Overrides:
beforeChildAdded in class org.zkoss.zk.ui.AbstractComponent

insertBefore

public boolean insertBefore(org.zkoss.zk.ui.Component child,
                            org.zkoss.zk.ui.Component refChild)
Specified by:
insertBefore in interface org.zkoss.zk.ui.Component
Overrides:
insertBefore in class org.zkoss.zk.ui.AbstractComponent

onChildRemoved

public void onChildRemoved(org.zkoss.zk.ui.Component child)
Specified by:
onChildRemoved in interface org.zkoss.zk.ui.sys.ComponentCtrl
Overrides:
onChildRemoved in class org.zkoss.zk.ui.AbstractComponent

clearSelectedTab

protected void clearSelectedTab()

clone

public java.lang.Object clone()
Specified by:
clone in interface org.zkoss.zk.ui.Component
Overrides:
clone in class XulElement

renderProperties

protected void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
                         throws java.io.IOException
Overrides:
renderProperties in class XulElement
Throws:
java.io.IOException


Copyright © 2012. All Rights Reserved.