Zimlet JavaScript API Reference - DwtTabView

Class DwtTabView


Extends DwtComposite.

This class represents a tabbed view. DwtTabView manages the z-index of the contained tabs.

Defined in: DwtTabView.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
DwtTabView(params, parent, className, posStyle, id)
Creates a tab view.
Method Summary
Method Attributes Method Name and Description
 
Adds a state change listener.
 
addTab(title, tabViewOrCallback, buttonId, index)
Adds a tab.
 
Gets the current tab.
 
Gets the tab count.
 
getTab(tabKey)
Gets the tab.
 
Gets the tab bar.
 
getTabButton(tabKey)
Gets the tab button.
 
getTabTitle(tabKey)
Gets the tab title.
 
getTabView(tabKey)
Gets the tab view.
 
Removes a state change listener.
 
setTabView(tabKey, tabView)
Sets the tab view.
 
switchToTab(tabKey)
Switches to the tab view.
Methods borrowed from class DwtComposite:
addChild, cleanupSeparators, clear, dispose, getChild, getChildren, getNumChildren, getTabGroupMember, removeChild, removeChildren
Methods borrowed from class DwtControl:
addClassName, addControlListener, addDisposeListener, addListener, appendElement, blur, clearContent, clearHandler, condClassName, delClassName, focus, getBounds, getClassName, getContent, getCursor, getData, getDragBox, getDragSource, getDropTarget, getEnabled, getFocusElement, getH, getHtmlElement, getHTMLElId, getInsetBounds, getInsets, getLocation, getMargins, getOpacity, getOuterSize, getPosition, getScrollContainer, getScrollStyle, getSize, getTooltipBase, getToolTipContent, getVisibility, getVisible, getW, getX, getXW, getY, getYH, getZIndex, hasFocus, isAlertShown, isDisposed, isInitialized, isListenerRegistered, notifyListeners, preventContextMenu, preventSelection, removeAllListeners, removeControlListener, removeDisposeListener, removeListener, reparent, reparentHtmlElement, replaceElement, setBounds, setClassName, setContent, setCursor, setData, setDisplay, setDisplayState, setDragBox, setDragSource, setDropTarget, setEnabled, setEventPropagation, setFocusElement, setHandler, setHtmlElementId, setLocation, setOpacity, setPosition, setScrollStyle, setSize, setToolTipContent, setVisibility, setVisible, setZIndex, showAlert, zShow
Class Detail
DwtTabView(params, parent, className, posStyle, id)
Creates a tab view.
Author: Greg Solovyev.
Parameters:
{hash} params
a hash of parameters
{DwtComposite} parent
the parent widget
{string} className
the CSS class
{constant} posStyle
the positioning style (see DwtControl)
{string} id
an explicit ID to use for the control's HTML element
Method Detail
addStateChangeListener(listener)
Adds a state change listener.
Parameters:
{AjxListener} listener
the listener

{string} addTab(title, tabViewOrCallback, buttonId, index)
Adds a tab.
Parameters:
{string} title
the text for the tab button
{DwtTabViewPage|AjxCallback} tabViewOrCallback
an instance of the tab view page or callback that returns an instance of DwtTabViewPage
buttonId
index
Returns:
{string} key for the added tab This key can be used to retrieve the tab using #getTab
See:
#getTab

{string} getCurrentTab()
Gets the current tab.
Returns:
{string} the tab key

{number} getNumTabs()
Gets the tab count.
Returns:
{number} the number of tabs

{DwtTabViewPage} getTab(tabKey)
Gets the tab.
Parameters:
{string} tabKey
the key for the tab
Returns:
{DwtTabViewPage} the view tab
See:
#addTab

{DwtTabBar} getTabBar()
Gets the tab bar.
Returns:
{DwtTabBar} the tab bar

{DwtTabButton} getTabButton(tabKey)
Gets the tab button.
Parameters:
{string} tabKey
the tab key
Returns:
{DwtTabButton} the tab button

{string} getTabTitle(tabKey)
Gets the tab title.
Parameters:
{string} tabKey
the tab key
Returns:
{string} the title

{DwtTabViewPage} getTabView(tabKey)
Gets the tab view.
Parameters:
{string} tabKey
the tab key
Returns:
{DwtTabViewPage} the tab view page

removeStateChangeListener(listener)
Removes a state change listener.
Parameters:
{AjxListener} listener
the listener

setTabView(tabKey, tabView)
Sets the tab view.
Parameters:
{string} tabKey
the tab key
{DwtTabViewPage|AjxCallback} tabView
an instance of the tab view page or callback that returns an instance of DwtTabViewPage

switchToTab(tabKey)
Switches to the tab view.
Parameters:
{string} tabKey
the tab key

Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:29 GMT-0400 (EDT)