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, HtmlBasedComponent, Component, Scope, ComponentCtrl, Tabbox, XulElement

public class Tabbox
extends XulElement
implements Tabbox

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
HtmlBasedComponent.ExtraCtrl
 
Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent
AbstractComponent.Children
 
Field Summary
 
Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent
_height, _left, _top, _width, _zclass
 
Fields inherited from class org.zkoss.zk.ui.AbstractComponent
_visible
 
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(Component child, Component refChild)
          Default: does nothing.
 java.lang.Object clone()
          Clones the component.
 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.
 Tabpanel getSelectedPanelApi()
          Returns the selected tab panel.
 Tab getSelectedTab()
          Returns the selected tab.
 Tab getSelectedTabApi()
          Returns the selected tab.
 Tabpanels getTabpanels()
          Returns the tabpanels that this tabbox owns.
 Tabpanels getTabpanelsApi()
          Returns the tabpanels that this tabbox owns.
 Tabs getTabs()
          Returns the tabs that this tabbox owns.
 Tabs getTabsApi()
          Returns the tabs that this tabbox owns.
 Toolbar getToolbar()
          Returns the auxiliary toolbar that this tabbox owns.
 java.lang.String getZclass()
          Returns the ZK Cascading Style class(es) for this component.
 boolean insertBefore(Component child, Component refChild)
          Inserts a child before the reference child.
 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(Component child)
          Default: does nothing.
protected  void renderProperties(ContentRenderer renderer)
          Renders the content of this component, excluding the enclosing tags and children.
 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 setSelectedPanelApi(Tabpanel panelApi)
          Sets the selected tab panel.
 void setSelectedTab(Tab tab)
          Sets the selected tab.
 void setSelectedTabApi(Tab tabApi)
          Sets the selected tab.
 void setTabscroll(boolean tabscroll)
          Sets whether to eable the tab scrolling
 
Methods inherited from class org.zkoss.zul.impl.XulElement
getAction, getContext, getCtrlKeys, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip
 
Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent
focus, getDraggable, getDroppable, getHeight, getHflex, getLeft, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, newExtraCtrl, service, setClass, setDraggable, setDroppable, setFocus, setHeight, setHflex, setLeft, setSclass, setStyle, setTooltiptext, setTop, setVflex, setWidth, setZclass, setZindex, setZIndex
 
Methods inherited from class org.zkoss.zk.ui.AbstractComponent
addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addForward, addForward, addForward, addForward, addMoved, addScopeListener, addSharedAnnotationMap, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, beforeParentChanged, containsVariable, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getClientEvents, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getExtraCtrl, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, newChildren, onChildAdded, onPageAttached, onPageDetached, onWrongValue, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, response, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setDefinition, setDefinition, setId, setPage, setPageBefore, setParent, setVariable, setVisible, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, unsetVariable, updateByClient, willPassivate, willPassivate, willSerialize, willSerialize
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.zkoss.zul.impl.api.XulElement
getAction, getContext, getCtrlKeys, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip
 
Methods inherited from interface org.zkoss.zk.ui.api.HtmlBasedComponent
focus, getHeight, getLeft, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex
 
Methods inherited from interface org.zkoss.zk.ui.Component
addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, containsVariable, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getDefinition, getDesktop, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, invalidate, isInvalidated, isListenerAvailable, isVisible, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setId, setPage, setPageBefore, setParent, setVariable, setVisible, setWidgetListener, setWidgetOverride, unsetVariable
 
Methods inherited from interface org.zkoss.zk.ui.ext.Scope
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute
 

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

getTabsApi

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

Specified by:
getTabsApi in interface Tabbox
Since:
3.5.2

getTabpanels

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


getTabpanelsApi

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

Specified by:
getTabpanelsApi in interface Tabbox
Since:
3.5.2

isTabscroll

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

Specified by:
isTabscroll in interface Tabbox
Since:
3.5.0

setTabscroll

public void setTabscroll(boolean tabscroll)
Sets whether to eable the tab scrolling

Specified by:
setTabscroll in interface Tabbox
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).

Specified by:
getPanelSpacing in interface Tabbox

setPanelSpacing

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

Specified by:
setPanelSpacing in interface Tabbox

getSelectedIndex

public int getSelectedIndex()
Returns the selected index.

Specified by:
getSelectedIndex in interface Tabbox

setSelectedIndex

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

Specified by:
setSelectedIndex in interface Tabbox

getSelectedPanel

public Tabpanel getSelectedPanel()
Returns the selected tab panel.


getSelectedPanelApi

public Tabpanel getSelectedPanelApi()
Returns the selected tab panel.

Specified by:
getSelectedPanelApi in interface Tabbox
Since:
3.5.2

setSelectedPanel

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


setSelectedPanelApi

public void setSelectedPanelApi(Tabpanel panelApi)
Sets the selected tab panel.

Specified by:
setSelectedPanelApi in interface Tabbox
Parameters:
panelApi - assume as a Tabpanel
Since:
3.5.2

getSelectedTab

public Tab getSelectedTab()
Returns the selected tab.


getSelectedTabApi

public Tab getSelectedTabApi()
Returns the selected tab.

Specified by:
getSelectedTabApi in interface Tabbox
Since:
3.5.2

setSelectedTab

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


setSelectedTabApi

public void setSelectedTabApi(Tab tabApi)
Sets the selected tab.

Specified by:
setSelectedTabApi in interface Tabbox
Parameters:
tabApi - assume as a Tab
Since:
3.5.2

getOrient

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

Default: "horizontal".

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

Specified by:
getOrient in interface Tabbox

setMold

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

Specified by:
setMold in interface Component
Overrides:
setMold in class AbstractComponent
Parameters:
mold - default , accordion and accordion-lite
See Also:
ComponentDefinition

setOrient

public void setOrient(java.lang.String orient)
               throws WrongValueException
Sets the orient.

Specified by:
setOrient in interface Tabbox
Parameters:
orient - either "horizontal" or "vertical".
Throws:
WrongValueException

isHorizontal

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

Specified by:
isHorizontal in interface Tabbox
Since:
3.0.3

isVertical

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

Specified by:
isVertical in interface Tabbox
Since:
3.0.3

getZclass

public java.lang.String getZclass()
Description copied from class: HtmlBasedComponent
Returns the ZK Cascading Style class(es) for this component. It usually depends on the implementation of the mold (@{link #getMold}).

Default: null (the default value depends on element).

HtmlBasedComponent.setZclass(java.lang.String)) will completely replace the default style of a component. In other words, the default style of a component is associated with the default value of HtmlBasedComponent.getZclass(). Once it is changed, the default style won't be applied at all. If you want to perform small adjustments, use HtmlBasedComponent.setSclass(java.lang.String) instead.

Specified by:
getZclass in interface HtmlBasedComponent
Overrides:
getZclass in class HtmlBasedComponent
See Also:
HtmlBasedComponent.getSclass()

beforeChildAdded

public void beforeChildAdded(Component child,
                             Component refChild)
Description copied from class: AbstractComponent
Default: does nothing.

Specified by:
beforeChildAdded in interface ComponentCtrl
Overrides:
beforeChildAdded in class AbstractComponent
Parameters:
child - the child to be added (never null).
refChild - another child component that the new child will be inserted before it. If null, the new child will be the last child.
See Also:
ComponentCtrl.beforeChildAdded(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component)

insertBefore

public boolean insertBefore(Component child,
                            Component refChild)
Description copied from interface: Component
Inserts a child before the reference child.

You could use Component.setParent(org.zkoss.zk.ui.Component) or Component.appendChild(org.zkoss.zk.ui.Component) instead of this method, unless you want to control where to put the child.

Note: Component.setParent(org.zkoss.zk.ui.Component) always calls back Component.insertBefore(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component) and/or Component.removeChild(org.zkoss.zk.ui.Component), while Component.insertBefore(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component) and Component.removeChild(org.zkoss.zk.ui.Component) always calls back Component.setParent(org.zkoss.zk.ui.Component), if the parent is changed. Thus, you don't need to override both Component.insertBefore(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.Component) and Component.setParent(org.zkoss.zk.ui.Component), if you want to customize the behavior.

Specified by:
insertBefore in interface Component
Overrides:
insertBefore in class AbstractComponent
Parameters:
child - the new child to be inserted.
refChild - the child before which you want the new child being inserted. If null, the new child is append to the end.
Returns:
true if newChild is added successfully or moved; false if it already has the specified child and the order doesn't change.

onChildRemoved

public void onChildRemoved(Component child)
Description copied from class: AbstractComponent
Default: does nothing.

Specified by:
onChildRemoved in interface ComponentCtrl
Overrides:
onChildRemoved in class AbstractComponent
See Also:
ComponentCtrl.onChildRemoved(org.zkoss.zk.ui.Component)

clone

public java.lang.Object clone()
Description copied from interface: Component
Clones the component. All of its children is cloned. Notice that the cloned component doesn't belong to any page, nor desktop. It doesn't have parent, either.

Specified by:
clone in interface Component
Overrides:
clone in class AbstractComponent

renderProperties

protected void renderProperties(ContentRenderer renderer)
                         throws java.io.IOException
Description copied from class: HtmlBasedComponent
Renders the content of this component, excluding the enclosing tags and children.

See also Render Special Properties

Overrides:
renderProperties in class XulElement
Throws:
java.io.IOException


Copyright © 2005-2009 Potix Corporation. All Rights Reserved. SourceForge.net Logo