Zimlet JavaScript API Reference - DwtTabBar

Class DwtTabBar


Extends DwtToolBar.

This class represents the tab bar, which is effectively a tool bar.

Defined in: DwtTabView.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
DwtTabBar(parent, tabCssClass, btnCssClass)
Creates a tab bar.
Method Summary
Method Attributes Method Name and Description
 
addButton(tabKey, tabTitle, id, index)
Adds a button.
 
addSelectionListener(tabKey, listener)
Adds a selection listener.
 
Adds a state change listener.
 
getButton(tabKey)
Gets the button.
 
Gets the current tab.
 
openTab(tabKey, skipNotify)
Opens the tab.
 
removeSelectionListener(tabKey, listener)
Removes a selection listener.
 
Removes a state change listener.
Methods borrowed from class DwtToolBar:
addChild, addFiller, addSeparator, addSpacer, focus, getItem, getItemCount, getItems, getKeyMapName
Methods borrowed from class DwtComposite:
cleanupSeparators, clear, dispose, getChild, getChildren, getNumChildren, getTabGroupMember, removeChild, removeChildren
Methods borrowed from class DwtControl:
addClassName, addControlListener, addDisposeListener, addListener, appendElement, blur, clearContent, clearHandler, condClassName, delClassName, 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
DwtTabBar(parent, tabCssClass, btnCssClass)
Creates a tab bar.
Parameters:
{DwtComposite} parent
the parent widget
{string} tabCssClass
the tab CSS class
{string} btnCssClass
the button CSS class
Method Detail
{DwtTabButton} addButton(tabKey, tabTitle, id, index)
Adds a button.
Parameters:
{string} tabKey
the the tab key
{string} tabTitle
the tab title
{string} id
the id
{number} index
the index
Returns:
{DwtTabButton} the newly added button

addSelectionListener(tabKey, listener)
Adds a selection listener.
Parameters:
{string} tabKey
the id used to create tab button in DwtTabBar.addButton
{AjxListener} listener
the listener

addStateChangeListener(listener)
Adds a state change listener.
Parameters:
{AjxListener} listener
the listener

{DwtTabButton} getButton(tabKey)
Gets the button.
Parameters:
{string} tabKey
the id used to create tab button in DwtTabBar.addButton
Returns:
{DwtTabButton} the button

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

openTab(tabKey, skipNotify)
Opens the tab.
Parameters:
{string} tabKey
the id used to create tab button in DwtTabBar.addButton
{boolean} skipNotify
if true, do not notify listeners

removeSelectionListener(tabKey, listener)
Removes a selection listener.
Parameters:
{string} tabKey
the id used to create tab button in DwtTabBar.addButton
{AjxListener} listener
the listener

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

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