Zimlet JavaScript API Reference - ZmAppChooser

Class ZmAppChooser


Extends ZmToolBar.

This class represents a zimbra application chooser. The chooser is the "tab application" toolbar shown in the Zimbra Web Client. The toolbar buttons are represented as "tabs".

Defined in: ZmAppChooser.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmAppChooser(params)
Method Summary
Method Attributes Method Name and Description
 
addButton(id, params)
Adds a button to the toolbar.
 
Adds a selection listener.
 
Removes a button.
 
replaceButton(oldId, newId, params)
Replaces a button.
 
Sets the specified button as selected.
 
Returns a string representation of the object.
Methods borrowed from class ZmToolBar:
createButton, enable, 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
ZmAppChooser(params)
Parameters:
{Hash} params
a hash of parameters
Method Detail
{ZmAppButton} addButton(id, params)
Adds a button to the toolbar.
Parameters:
{String} id
the button id
{Hash} params
a hash of parameters
{String} params.text
the text
{String} params.image
the image
{int} params.index
the index
{String} params.tooltip
the tool top
{String} params.textPrecedence
the image precedence
{String} params.imagePrecedence
the image precedence
Returns:
{ZmAppButton} the newly created button

addSelectionListener(listener)
Adds a selection listener.
Parameters:
{AjxListener} listener
the listener

removeButton(id)
Removes a button.
Parameters:
{String} id
the id of the button to remove

{ZmAppButton} replaceButton(oldId, newId, params)
Replaces a button.
Parameters:
{String} oldId
the old button id
{String} newId
the new button id
{Hash} params
a hash of parameters
{String} params.text
the text
{String} params.image
the image
{int} params.index
the index
{String} params.tooltip
the tool tip
{String} params.textPrecedence
the text display precedence
{String} params.imagePrecedence
the image display precedence
Returns:
{ZmAppButton} the newly created button

setSelected(id)
Sets the specified button as selected.
Parameters:
{String} id
the button id

{String} toString()
Returns a string representation of the object.
Returns:
{String} a string representation of the object

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