Zimlet JavaScript API Reference - ZmPreferencesPage

Class ZmPreferencesPage


Extends DwtTabViewPage.

This class represents a single page of preferences available by selecting one of the preference tabs. During construction, skeletal HTML is created. The preferences are not added until the page becomes visible.

Defined in: ZmPreferencesPage.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmPreferencesPage(parent, section, controller, id)
Creates an empty preferences page of the given type.
Method Summary
Method Attributes Method Name and Description
 
addCommand(batchCmd)
Adds the modify command to the given batch command.
 
getFormValue(id, setup, control)
Gets the value of the preference control.
 
getTabGroupMember()
 
Gets the title.
 
Checks if the data is dirty.
 
setFormValue(id, value, setup, control)
Sets the value of the preference control.
 
Fills the page with preferences that belong to this page, if that has not been done already.
Methods borrowed from class DwtTabViewPage:
getContentHtmlElement, hideMe, resetSize
Methods borrowed from class DwtComposite:
addChild, cleanupSeparators, clear, dispose, getChild, getChildren, getNumChildren, 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, 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
ZmPreferencesPage(parent, section, controller, id)
Creates an empty preferences page of the given type.
Author: Conrad Damon.
Parameters:
{DwtControl} parent
the containing widget
{object} section
the page
{ZmPrefController} controller
the prefs controller
id
Method Detail
addCommand(batchCmd)
Adds the modify command to the given batch command.
Parameters:
{ZmBatchCommand} batchCmd
the batch command

{String} getFormValue(id, setup, control)
Gets the value of the preference control.
Parameters:
{String} id
the preference id
{Object} setup Optional
the preference descriptor
{DwtControl} control Optional
the preference control
Returns:
{String} the value

getTabGroupMember()

{String} getTitle()
Gets the title.
Returns:
{String} the title

{Boolean} isDirty()
Checks if the data is dirty.
Returns:
{Boolean} true if the data is dirty

setFormValue(id, value, setup, control)
Sets the value of the preference control.
Parameters:
{String} id
the preference id
{Object} value
the preference value
{Object} setup Optional
the preference descriptor
{DwtControl} control Optional
the preference control

showMe()
Fills the page with preferences that belong to this page, if that has not been done already. Note this method is only called when the tab is selected and the page becomes visible.

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