[ Mini Kiebo ]
Server: Windows NT DESKTOP-5B8S0D4 6.2 build 9200 (Windows 8 Professional Edition) i586
Path:
D:
/
Backup
/
05122024
/
htdocs
/
simpeg
/
zapatec
/
zpeditor
/
utils
/
jsdocs
/
Zapatec
/
[
Home
]
File: ProgressBar.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <TITLE> Zapatec.ProgressBar </TITLE> <LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style"> </HEAD> <SCRIPT> function asd() { parent.document.title="Zapatec.ProgressBar"; } </SCRIPT> <BODY BGCOLOR="white" onload="asd();"> <!-- ========== START OF NAVBAR ========== --> <A NAME="navbar_bottom"><!-- --></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> <TR> <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary-progressbar.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"--> <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD--> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"--><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> <B>Zapatec Utils</B> </EM> </TD </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../Zapatec/PreloadImages.html"><B>PREV CLASS</B></A><!-- NEXT CLASS --> <A HREF="../Zapatec/Spinner.html"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../index.html" TARGET="_top"><B>FRAMES</B></A> <A HREF="" TARGET="_top"><B>NO FRAMES</B></A> <SCRIPT> <!-- if(window==top) { document.writeln('<A HREF="../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <!-- =========== END OF NAVBAR =========== --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2>Class Zapatec.ProgressBar</H2> <PRE>Object | +--<a href='../Zapatec/EventDriven.html'>Zapatec.EventDriven</a> | +--<a href='../Zapatec/Widget.html'>Zapatec.Widget</a> | +--<b>Zapatec.ProgressBar</b> </PRE> <HR> <DL> <!-- Class definition --> <DT>class <B>Zapatec.ProgressBar</B> <DT>extends <a href='../Zapatec/Widget.html'>Zapatec.Widget</a> </DL> <P> <I>Defined in <a href='../overview-summary-progressbar.js.html'>progressbar.js</a></I><BR/><BR/> </P> <HR> <!-- ======== NESTED CLASS SUMMARY ======== --> <!-- ======== END NESTED CLASS SUMMARY ======== --> <!-- =========== FIELD SUMMARY =========== --> <A NAME=""><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TD><B>Fields inherited from class <A HREF="../Zapatec/Widget.html">Zapatec.Widget</A></B></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE> <a href='../Zapatec/Widget.html#config'>config</a> </CODE></TD> </TR> </TABLE> <!-- =========== END FIELD SUMMARY =========== --> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <A NAME="constructor_summary"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=2><FONT SIZE="+2"> <B>Constructor Summary</B></FONT></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD> <CODE> <B> <A HREF="#Zapatec.ProgressBar()">Zapatec.ProgressBar</A></B>(<object> objArgs) </CODE> <BR> ProgressBar class. </TD> </TR> </TABLE> <!-- ======== END CONSTRUCTOR SUMMARY ======== --> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=2><FONT SIZE="+2"> <B>Method Summary</B></FONT></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> <a href="../Object.html">Object</a></CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#calculatePercentage">calculatePercentage</A></B>() </CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> <a href="../Object.html">Object</a></CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#calculateWidth">calculateWidth</A></B>() </CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#cancel">cancel</A></B>() </CODE> <BR> Fires cancel event </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#displayLabel">displayLabel</A></B>() </CODE> <BR> Displays labels </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> float</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#getProgress">getProgress</A></B>() </CODE> <BR> Get current progress </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#hide">hide</A></B>() </CODE> <BR> Hides ProgressBar </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#init">init</A></B>(<object> objArgs) </CODE> <BR> Initializes object. </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> void</CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#redraw">redraw</A></B>() </CODE> <BR> Redraws Progressbar after changing of currentValue </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"> <FONT SIZE="-1"> <CODE> <a href="../Object.html">Object</a></CODE> </FONT> </TD> <TD> <CODE> <B> <A HREF="#setProgress">setProgress</A></B>(value) </CODE> <BR> Set new progress value </TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TD><B>Methods inherited from class <a href="../Zapatec/Widget.html">Zapatec.Widget</a></B></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE> <!-- Inherited methods --> <a href='../Zapatec/Widget.html#reconfigure'>reconfigure</a>, <a href='../Zapatec/Widget.html#getConfiguration'>getConfiguration</a>, <a href='../Zapatec/Widget.html#addCircularRef'>addCircularRef</a>, <a href='../Zapatec/Widget.html#createProperty'>createProperty</a>, <a href='../Zapatec/Widget.html#discard'>discard</a>, <a href='../Zapatec/Widget.html#defineConfigOption'>defineConfigOption</a>, <a href='../Zapatec/Widget.html#addUserEventListeners'>addUserEventListeners</a>, <a href='../Zapatec/Widget.html#addStandardEventListeners'>addStandardEventListeners</a>, <a href='../Zapatec/Widget.html#loadTheme'>loadTheme</a>, <a href='../Zapatec/Widget.html#getClassName'>getClassName</a>, <a href='../Zapatec/Widget.html#formElementId'>formElementId</a>, <a href='../Zapatec/Widget.html#showContainer'>showContainer</a>, <a href='../Zapatec/Widget.html#hideContainer'>hideContainer</a>, <a href='../Zapatec/Widget.html#showHideContainer'>showHideContainer</a>, <a href='../Zapatec/Widget.html#loadData'>loadData</a>, <a href='../Zapatec/Widget.html#loadDataHtml'>loadDataHtml</a>, <a href='../Zapatec/Widget.html#loadDataHtmlText'>loadDataHtmlText</a>, <a href='../Zapatec/Widget.html#loadDataJson'>loadDataJson</a>, <a href='../Zapatec/Widget.html#loadDataXml'>loadDataXml</a>, <a href='../Zapatec/Widget.html#receiveData'>receiveData</a>, <a href='../Zapatec/Widget.html#replyData'>replyData</a>, <a href='../Zapatec/Widget.html#replyDataCancel'>replyDataCancel</a>, <a href='../Zapatec/Widget.html#replyDataReturn'>replyDataReturn</a>, <a href='../Zapatec/Widget.html#acceptData'>acceptData</a>, <a href='../Zapatec/Widget.html#getMessage'>getMessage</a> </CODE></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TD><B>Methods inherited from class <a href="../Zapatec/EventDriven.html">Zapatec.EventDriven</a></B></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE> <!-- Inherited methods --> <a href='../Zapatec/EventDriven.html#addEventListener'>addEventListener</a>, <a href='../Zapatec/EventDriven.html#unshiftEventListener'>unshiftEventListener</a>, <a href='../Zapatec/EventDriven.html#removeEventListener'>removeEventListener</a>, <a href='../Zapatec/EventDriven.html#getEventListeners'>getEventListeners</a>, <a href='../Zapatec/EventDriven.html#isEventListener'>isEventListener</a>, <a href='../Zapatec/EventDriven.html#isEvent'>isEvent</a>, <a href='../Zapatec/EventDriven.html#removeEvent'>removeEvent</a>, <a href='../Zapatec/EventDriven.html#fireEvent'>fireEvent</a> </CODE></TD> </TR> </TABLE> <P> <!-- ========== END METHOD SUMMARY =========== --> <!-- ============ FIELD DETAIL START =========== --> <!-- ============ FIELD DETAIL END =========== --> <!-- ========= CONSTRUCTOR DETAIL START ======== --> <A NAME="constructor_detail"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=1> <FONT SIZE="+2"><B>Constructor Detail</B></FONT> </TD> </TR> </TABLE> <A NAME="Zapatec.ProgressBar()"><!-- --></A><H3> Zapatec.ProgressBar</H3> <PRE><B>Zapatec.ProgressBar</B>(<object> objArgs)</PRE> <UL> ProgressBar class. </UL> <UL> <B>Parameters:</B> <UL><CODE>objArgs</CODE> - User configuration </UL> </UL> <!-- Constructor return value(s) --> <!-- End constructor return value(s) --> <!-- ADDITIONAL ATTRIBUTES --> <HR/> <!-- END ADDITIONAL ATTRIBUTES --> <!-- ========= CONSTRUCTOR DETAIL END ======== --> <!-- ============ METHOD DETAIL START ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=1><FONT SIZE="+2"> <B>Method Detail</B></FONT> </TD> </TR> </TABLE> <!-- One single method detail entry --> <A NAME="calculatePercentage"><!-- --></A> <H3>calculatePercentage</H3> <PRE><a href="../Object.html">Object</a> <B>calculatePercentage</B>()</PRE> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="calculateWidth"><!-- --></A> <H3>calculateWidth</H3> <PRE><a href="../Object.html">Object</a> <B>calculateWidth</B>()</PRE> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="cancel"><!-- --></A> <H3>cancel</H3> <PRE>void <B>cancel</B>()</PRE> <UL>Fires cancel event</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="displayLabel"><!-- --></A> <H3>displayLabel</H3> <PRE>void <B>displayLabel</B>()</PRE> <UL>Displays labels</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="getProgress"><!-- --></A> <H3>getProgress</H3> <PRE>float <B>getProgress</B>()</PRE> <UL>Get current progress</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <UL> <B>Returns:</B> <UL> Current progress value </UL> </UL> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="hide"><!-- --></A> <H3>hide</H3> <PRE>void <B>hide</B>()</PRE> <UL>Hides ProgressBar</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="init"><!-- --></A> <H3>init</H3> <PRE>void <B>init</B>(<object> objArgs)</PRE> <UL>Initializes object.</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>objArgs</CODE> - User configuration </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="redraw"><!-- --></A> <H3>redraw</H3> <PRE>void <B>redraw</B>()</PRE> <UL>Redraws Progressbar after changing of currentValue</UL> <!-- METHOD PARAMETERS START --> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <A NAME="setProgress"><!-- --></A> <H3>setProgress</H3> <PRE><a href="../Object.html">Object</a> <B>setProgress</B>(value)</PRE> <UL>Set new progress value</UL> <!-- METHOD PARAMETERS START --> <UL> <B>Parameters:</B> <UL><CODE>value</CODE> - Progress value </UL> </UL> <!-- METHOD PARAMETERS END --> <!-- ADDITIONAL ATTRIBUTES START --> <!-- ADDITIONAL ATTRIBUTES END --> <HR> <!-- ============ METHOD DETAIL END ========== --> <!-- ========= END OF CLASS DATA ========= --> <!-- ========== START OF NAVBAR ========== --> <A NAME="navbar_bottom"><!-- --></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> <TR> <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary-progressbar.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-tree.html"><FONT CLASS="NavBarFont1"><b>Tree</b></FONT></A> </TD> <!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"--> <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD--> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> <B>Zapatec Utils</B> </EM> </TD </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../Zapatec/PreloadImages.html"><B>PREV CLASS</B></A><!-- NEXT CLASS --> <A HREF="../Zapatec/Spinner.html"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../index.html" TARGET="_top"><B>FRAMES</B></A> <A HREF="" TARGET="_top"><B>NO FRAMES</B></A> <SCRIPT> <!-- if(window==top) { document.writeln('<A HREF="../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <!-- =========== END OF NAVBAR =========== --> <HR> <FONT SIZE="-1"> </FONT> <div class="jsdoc_ctime">Documentation generated by <a href="http://jsdoc.sourceforge.net/" target="_parent">JSDoc</a> on Thu Aug 16 12:18:39 2007</div> </BODY> </HTML>