Zimlet JavaScript API Reference - DwtProgressBar

Class DwtProgressBar


Extends DwtComposite.

This class represents a progress bar.

Defined in: DwtProgressBar.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
DwtProgressBar(parent, className, posStyle)
Creates a progress bar.
Method Summary
Method Attributes Method Name and Description
 
Gets the maximum value.
 
Gets the value.
 
setLabel(text, isRightAlign)
Sets the label.
 
Sets the maximum value.
 
Sets the progress background color.
 
Sets the progress CSS class.
 
Sets the process CSS style.
 
setValue(val)
Sets the progress value.
 
Sets the value by percentage.
 
Sets the whole background color.
 
Sets the whole CSS class.
 
Sets the while CSS style.
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, 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
DwtProgressBar(parent, className, posStyle)
Creates a progress bar.
Author: Greg Solovyev.
Parameters:
{DwtComposite} parent
the parent container
{string} className
the CSS class name
{constant} posStyle
the position style (see DwtControl)
Method Detail
{number} getMaxValue()
Gets the maximum value.
Returns:
{number} the maximum value

{number} getValue()
Gets the value.
Returns:
{number} the value

setLabel(text, isRightAlign)
Sets the label.
Parameters:
{string} text
the label
{boolean} isRightAlign
if true, if the label is right aligned

setMaxValue(val)
Sets the maximum value.
Parameters:
{number} val
the maximum value

setProgressBgColor(var)
Sets the progress background color.
Parameters:
{string} var
the color

setProgressCssClass(var)
Sets the progress CSS class.
Parameters:
{string} var
the color

setProgressCssStyle(var)
Sets the process CSS style.
Parameters:
{string} var
the color

setValue(val)
Sets the progress value.
Parameters:
{number} val
the value

setValueByPercent(percent)
Sets the value by percentage.
Parameters:
{string} percent
the value as a percentage (for example: "10%")

setWholeBgColor(var)
Sets the whole background color.
Parameters:
{string} var
the color

setWholeCssClass(var)
Sets the whole CSS class.
Parameters:
{string} var
the color

setWholeCssStyle(var)
Sets the while CSS style.
Parameters:
{string} var
the color

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