org.zkoss.zul.api
Interface Tabbox

All Superinterfaces:
java.lang.Cloneable, Component, HtmlBasedComponent, Scope, java.io.Serializable, XulElement
All Known Implementing Classes:
Tabbox

public interface 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.

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

Since:
3.5.2
Author:
tomyeh

Field Summary
 
Fields inherited from interface org.zkoss.zk.ui.Component
APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE
 
Method Summary
 java.lang.String getOrient()
          Returns the orient.
 java.lang.String getPanelSpacing()
          Returns the spacing between Tabpanel.
 int getSelectedIndex()
          Returns the selected index.
 Tabpanel getSelectedPanelApi()
          Returns the selected tab panel.
 Tab getSelectedTabApi()
          Returns the selected tab.
 Tabpanels getTabpanelsApi()
          Returns the tabpanels that this tabbox owns.
 Tabs getTabsApi()
          Returns the tabs that this tabbox owns.
 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 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 setSelectedPanelApi(Tabpanel panel)
          Sets the selected tab panel.
 void setSelectedTabApi(Tab tab)
          Sets the selected tab.
 void setTabscroll(boolean tabscroll)
          Sets whether to eable the tab scrolling
 
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, getZclass, 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, clone, 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, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, setWidgetListener, setWidgetOverride, unsetVariable
 
Methods inherited from interface org.zkoss.zk.ui.ext.Scope
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute
 

Method Detail

getTabsApi

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


getTabpanelsApi

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


isTabscroll

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


setTabscroll

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


getPanelSpacing

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

Default: null (no spacing).


setPanelSpacing

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


getSelectedIndex

int getSelectedIndex()
Returns the selected index.


setSelectedIndex

void setSelectedIndex(int j)
Sets the selected index.


getSelectedPanelApi

Tabpanel getSelectedPanelApi()
Returns the selected tab panel.


setSelectedPanelApi

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


getSelectedTabApi

Tab getSelectedTabApi()
Returns the selected tab.


setSelectedTabApi

void setSelectedTabApi(Tab tab)
Sets the selected tab.


getOrient

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

Default: "horizontal".

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


setOrient

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

Parameters:
orient - either "horizontal" or "vertical".
Throws:
WrongValueException

isHorizontal

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


isVertical

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



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