Zimlet JavaScript API Reference - ZmChooseFolderDialog

Class ZmChooseFolderDialog


Extends ZmDialog.

This class represents choose folder dialog.

Defined in: ZmChooseFolderDialog.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmChooseFolderDialog(shell, className)
Creates a dialog with various trees so a user can select a folder.
Method Summary
Method Attributes Method Name and Description
 
getOverviewId(part, appName)
 
popup(params)
Since this dialog is intended for use in a variety of situations, we need to be able to create different sorts of overviews based on what the calling function wants.
Methods borrowed from class ZmDialog:
setView
Methods borrowed from class DwtDialog:
associateEnterWithButton, getButton, getButtonEnabled, registerCallback, resetButtonStates, setButtonEnabled, setButtonListener, setButtonVisible, setEnterListener, unregisterCallback
Methods borrowed from class DwtBaseDialog:
addEnterListener, addPopdownListener, addPopupListener, cleanup, isPoppedUp, popdown, removePopdownListener, removePopupListener, reset, setContent, setTitle
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, 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
ZmChooseFolderDialog(shell, className)
Creates a dialog with various trees so a user can select a folder.
Parameters:
{DwtControl} shell
the parent
{String} className
the class name
Method Detail
getOverviewId(part, appName)
Parameters:
part
appName

popup(params)
Since this dialog is intended for use in a variety of situations, we need to be able to create different sorts of overviews based on what the calling function wants. By default, we show the folder tree view.
Parameters:
{Hash} params
a hash of parameters
{Object} params.data
a array of items, a folder, an item or null
{Array} params.treeIds
a list of trees to show
{String} params.overviewId
the overview ID
{Hash} params.omit
a list IDs to not show
{String} params.title
the dialog title
{String} params.description
the description of what the user is selecting
{Boolean} params.skipReadOnly
if true, read-only folders will not be displayed
{Boolean} params.skipRemote
if true, remote folders (mountpoints) will not be displayed
{Boolean} params.hideNewButton
if true, new button will not be shown
{Boolean} params.noRootSelect
if true, do not make root tree item(s) selectable

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