Zimlet JavaScript API Reference - ZmNavToolBar

Class ZmNavToolBar


Extends ZmButtonToolBar.

Navigation toolbar for the client. This toolbar is affected by every push/pop of a view and must be context sensitive since it can custom apply to any view. A new class was created since nav toolbar may be expanded in the future (i.e. to incl. a text input indicating current page, etc)

Defined in: ZmNavToolBar.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmNavToolBar(params)
Creates a navigation tool bar.
Fields borrowed from class ZmButtonToolBar:
opList
Method Summary
Method Attributes Method Name and Description
 
enable(ids, enabled)
Enables/disables buttons.
 
setText(text)
Sets the text.
 
setToolTip(buttonId, tooltip)
Sets the tool tip for the button.
Methods borrowed from class ZmButtonToolBar:
addOp, createOp, createZimletOp, getActionsButton, getActionsMenu, getOp, getTagMenu, removeOp
Methods borrowed from class ZmToolBar:
addSelectionListener, createButton, enableAll, getButton, removeSelectionListener, setData, setItemVisible, setSize
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, setDisplay, setDisplayState, setDragBox, setDragSource, setDropTarget, setEnabled, setEventPropagation, setFocusElement, setHandler, setHtmlElementId, setLocation, setOpacity, setPosition, setScrollStyle, setToolTipContent, setVisibility, setVisible, setZIndex, showAlert, zShow
Class Detail
ZmNavToolBar(params)
Creates a navigation tool bar.
Parameters:
{Hash} params
a hash of parameters
{DwtComposite} params.parent
the containing widget
{constant} params.posStyle
the positioning style
{String} params.className
the CSS class name
{Boolean} params.hasText
if true, this toolbar includes text in the middle
{constant} params.context
the view ID (used to generate button IDs)
Method Detail
enable(ids, enabled)
Enables/disables buttons.
Parameters:
{Array} ids
a list of button IDs
{Boolean} enabled
if true, enable the buttons

setText(text)
Sets the text.
Parameters:
{String} text
the text

setToolTip(buttonId, tooltip)
Sets the tool tip for the button.
Parameters:
{String} buttonId
the button id
{String} tooltip
the tool tip

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