Zimlet JavaScript API Reference - DwtToolBar

Class DwtToolBar


Extends DwtComposite.

Creates a toolbar. Components must be added via the add*() functions. A toolbar is a horizontal or vertical strip of widgets (usually buttons).

Defined in: DwtToolBar.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
DwtToolBar(params)
Creates a toolbar.
Field Summary
Field Attributes Field Name and Description
<static>  
DwtToolBar.HORIZ_STYLE
Defines the "horizontal" style.
<static>  
DwtToolBar.VERT_STYLE
Defines the "vertical" style.
Method Summary
Method Attributes Method Name and Description
 
addChild(child, index)
Adds a child item.
 
addFiller(className, index)
Adds a filler.
 
addSeparator(className, index)
Adds a separator.
 
addSpacer(className, index)
Adds a spacer.
 
focus(item)
Focuses the current item.
 
getItem(index)
Gets the item.
 
Gets the item count.
 
Gets the items.
 
Gets the key map name.
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
DwtToolBar(params)
Creates a toolbar.
Author: Ross Dargahi.
Parameters:
{hash} params
a hash of parameters
{DwtComposite} params.parent
the parent widget
{string} params.className
the CSS class
{DwtToolBar.HORIZ_STYLE|DwtToolBar.VERT_STYLE} params.posStyle
the positioning style
{constant} params.style
the menu style
{number} params.index
the index at which to add this control among parent's children
Field Detail
<static> DwtToolBar.HORIZ_STYLE
Defines the "horizontal" style.

<static> DwtToolBar.VERT_STYLE
Defines the "vertical" style.
Method Detail
addChild(child, index)
Adds a child item.
Parameters:
{Object} child
the child item
{number} index
the index for the child

{Object} addFiller(className, index)
Adds a filler.
Parameters:
{string} className
the CSS class name
{number} index
the index for the filler
Returns:
{Object} the newly added element

{Object} addSeparator(className, index)
Adds a separator.
Parameters:
{string} className
the separator CSS class name
{number} index
the index for the separator
Returns:
{Object} the newly added element

{Object} addSpacer(className, index)
Adds a spacer.
Parameters:
{string} className
the spacer CSS class name
{number} index
the index for the spacer
Returns:
{Object} the newly added element

focus(item)
Focuses the current item.
Parameters:
{DwtControl} item
(optional) specific toolbar item to focus

{Object} getItem(index)
Gets the item.
Parameters:
{int} index
the index
Returns:
{Object} the item

{number} getItemCount()
Gets the item count.
Returns:
{number} the size of the children items

{array} getItems()
Gets the items.
Returns:
{array} an array of children items

{string} getKeyMapName()
Gets the key map name.
Returns:
{string} the key map name

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