PageRenderTime 45ms CodeModel.GetById 15ms RepoModel.GetById 0ms app.codeStats 0ms

/www/tags/NOV_07_2009/htdocs/api/org/gjt/sp/util/ProgressObserver.html

#
HTML | 247 lines | 205 code | 32 blank | 10 comment | 0 complexity | 0f1147997d9a3b342d2247973c4493e8 MD5 | raw file
Possible License(s): BSD-3-Clause, AGPL-1.0, Apache-2.0, LGPL-2.0, LGPL-3.0, GPL-2.0, CC-BY-SA-3.0, LGPL-2.1, GPL-3.0, MPL-2.0-no-copyleft-exception, IPL-1.0 
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <!--NewPage-->
    3. 

  3. <HTML>
    4. 

  4. <HEAD>
    5. 

  5. <!-- Generated by javadoc (build 1.5.0_14) on Tue Jul 22 07:14:16 GMT-08:00 2008 -->
    6. 

  6. <TITLE>
    7. 

  7. ProgressObserver (jEdit API)
    8. 

  8. </TITLE>
    9. 

  9. 

  10. <META NAME="keywords" CONTENT="org.gjt.sp.util.ProgressObserver interface">
    11. 

  11. 

  12. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
    13. 

  13. 

  14. 

  15. <NOSCRIPT>
    16. 

  16. </NOSCRIPT>
    17. 

  17. 

  18. </HEAD>
    19. 

  19. 

  20. <BODY BGCOLOR="white" >
    21. 

  21. 

  22. 

  23. <!-- ========= START OF TOP NAVBAR ======= -->
    24. 

  24. <A NAME="navbar_top"><!-- --></A>
    25. 

  25. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
    26. 

  26. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    27. 

  27. <TR>
    28. 

  28. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    29. 

  29. <A NAME="navbar_top_firstrow"><!-- --></A>
    30. 

  30. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    31. 

  31.   <TR ALIGN="center" VALIGN="top">
    32. 

  32.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    33. 

  33.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    34. 

  34.   <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    35. 

  35.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ProgressObserver.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    36. 

  36.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    37. 

  37.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    38. 

  38.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    39. 

  39.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    40. 

  40.   </TR>
    41. 

  41. </TABLE>
    42. 

  42. </TD>
    43. 

  43. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    44. 

  44. </EM>
    45. 

  45. </TD>
    46. 

  46. </TR>
    47. 

  47. 

  48. <TR>
    49. 

  49. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    50. 

  50. &nbsp;<A HREF="../../../../org/gjt/sp/util/Log.html" title="class in org.gjt.sp.util"><B>PREV CLASS</B></A>&nbsp;
    51. 

  51. &nbsp;<A HREF="../../../../org/gjt/sp/util/PropertiesBean.html" title="class in org.gjt.sp.util"><B>NEXT CLASS</B></A></FONT></TD>
    52. 

  52. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    53. 

  53.   <A HREF="../../../../index.html?org/gjt/sp/util/ProgressObserver.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    54. 

  54. &nbsp;<A HREF="ProgressObserver.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    55. 

  55. &nbsp;
    56. 

  56. <NOSCRIPT>
    57. 

  57.   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
    58. 

  58. </NOSCRIPT>
    59. 

  59. 

  60. 

  61. </FONT></TD>
    62. 

  62. </TR>
    63. 

  63. <TR>
    64. 

  64. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    65. 

  65.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
    66. 

  66. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    67. 

  67. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    68. 

  68. </TR>
    69. 

  69. </TABLE>
    70. 

  70. <A NAME="skip-navbar_top"></A>
    71. 

  71. <!-- ========= END OF TOP NAVBAR ========= -->
    72. 

  72. 

  73. <HR>
    74. 

  74. <!-- ======== START OF CLASS DATA ======== -->
    75. 

  75. <H2>
    76. 

  76. <FONT SIZE="-1">
    77. 

  77. org.gjt.sp.util</FONT>
    78. 

  78. <BR>
    79. 

  79. Interface ProgressObserver</H2>
    80. 

  80. <DL>
    81. 

  81. <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/gjt/sp/jedit/bufferio/BufferAutosaveRequest.html" title="class in org.gjt.sp.jedit.bufferio">BufferAutosaveRequest</A>, <A HREF="../../../../org/gjt/sp/jedit/bufferio/BufferInsertRequest.html" title="class in org.gjt.sp.jedit.bufferio">BufferInsertRequest</A>, <A HREF="../../../../org/gjt/sp/jedit/bufferio/BufferIORequest.html" title="class in org.gjt.sp.jedit.bufferio">BufferIORequest</A>, <A HREF="../../../../org/gjt/sp/jedit/bufferio/BufferLoadRequest.html" title="class in org.gjt.sp.jedit.bufferio">BufferLoadRequest</A>, <A HREF="../../../../org/gjt/sp/jedit/bufferio/BufferSaveRequest.html" title="class in org.gjt.sp.jedit.bufferio">BufferSaveRequest</A>, <A HREF="../../../../org/gjt/sp/jedit/io/CopyFileWorker.html" title="class in org.gjt.sp.jedit.io">CopyFileWorker</A>, <A HREF="../../../../org/gjt/sp/jedit/bufferio/MarkersSaveRequest.html" title="class in org.gjt.sp.jedit.bufferio">MarkersSaveRequest</A>, <A HREF="../../../../org/gjt/sp/util/WorkRequest.html" title="class in org.gjt.sp.util">WorkRequest</A></DD>
    82. 

  82. </DL>
    83. 

  83. <HR>
    84. 

  84. <DL>
    85. 

  85. <DT><PRE>public interface <B>ProgressObserver</B></DL>
    86. 

  86. </PRE>
    87. 

  87. 

  88. <P>
    89. 

  89. Interface used to monitor things that can progress.
    90. 

  90. <P>
    91. 

  91. 

  92. <P>
    93. 

  93. <DL>
    94. 

  94. <DT><B>Since:</B></DT>
    95. 

  95.   <DD>jEdit 4.3pre3</DD>
    96. 

  96. </DL>
    97. 

  97. <HR>
    98. 

  98. 

  99. <P>
    100. 

  100. 

  101. <!-- ========== METHOD SUMMARY =========== -->
    102. 

  102. 

  103. <A NAME="method_summary"><!-- --></A>
    104. 

  104. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    105. 

  105. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    106. 

  106. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    107. 

  107. <B>Method Summary</B></FONT></TH>
    108. 

  108. </TR>
    109. 

  109. <TR BGCOLOR="white" CLASS="TableRowColor">
    110. 

  110. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    111. 

  111. <CODE>&nbsp;void</CODE></FONT></TD>
    112. 

  112. <TD><CODE><B><A HREF="../../../../org/gjt/sp/util/ProgressObserver.html#setMaximum(long)">setMaximum</A></B>(long&nbsp;value)</CODE>
    113. 

  113. 

  114. <BR>
    115. 

  115. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Update the maximum value.</TD>
    116. 

  116. </TR>
    117. 

  117. <TR BGCOLOR="white" CLASS="TableRowColor">
    118. 

  118. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    119. 

  119. <CODE>&nbsp;void</CODE></FONT></TD>
    120. 

  120. <TD><CODE><B><A HREF="../../../../org/gjt/sp/util/ProgressObserver.html#setStatus(java.lang.String)">setStatus</A></B>(java.lang.String&nbsp;status)</CODE>
    121. 

  121. 

  122. <BR>
    123. 

  123. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Update the status label.</TD>
    124. 

  124. </TR>
    125. 

  125. <TR BGCOLOR="white" CLASS="TableRowColor">
    126. 

  126. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    127. 

  127. <CODE>&nbsp;void</CODE></FONT></TD>
    128. 

  128. <TD><CODE><B><A HREF="../../../../org/gjt/sp/util/ProgressObserver.html#setValue(long)">setValue</A></B>(long&nbsp;value)</CODE>
    129. 

  129. 

  130. <BR>
    131. 

  131. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Update the progress value.</TD>
    132. 

  132. </TR>
    133. 

  133. </TABLE>
    134. 

  134. &nbsp;
    135. 

  135. <P>
    136. 

  136. 

  137. <!-- ============ METHOD DETAIL ========== -->
    138. 

  138. 

  139. <A NAME="method_detail"><!-- --></A>
    140. 

  140. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    141. 

  141. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    142. 

  142. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    143. 

  143. <B>Method Detail</B></FONT></TH>
    144. 

  144. </TR>
    145. 

  145. </TABLE>
    146. 

  146. 

  147. <A NAME="setValue(long)"><!-- --></A><H3>
    148. 

  148. setValue</H3>
    149. 

  149. <PRE>
    150. 

  150. void <B>setValue</B>(long&nbsp;value)</PRE>
    151. 

  151. <DL>
    152. 

  152. <DD>Update the progress value.
    153. 

  153. <P>
    154. 

  154. <DD><DL>
    155. 

  155. <DT><B>Parameters:</B><DD><CODE>value</CODE> - the new value<DT><B>Since:</B></DT>
    156. 

  156.   <DD>jEdit 4.3pre3</DD>
    157. 

  157. </DL>
    158. 

  158. </DD>
    159. 

  159. </DL>
    160. 

  160. <HR>
    161. 

  161. 

  162. <A NAME="setMaximum(long)"><!-- --></A><H3>
    163. 

  163. setMaximum</H3>
    164. 

  164. <PRE>
    165. 

  165. void <B>setMaximum</B>(long&nbsp;value)</PRE>
    166. 

  166. <DL>
    167. 

  167. <DD>Update the maximum value.
    168. 

  168. <P>
    169. 

  169. <DD><DL>
    170. 

  170. <DT><B>Parameters:</B><DD><CODE>value</CODE> - the new maximum value<DT><B>Since:</B></DT>
    171. 

  171.   <DD>jEdit 4.3pre3</DD>
    172. 

  172. </DL>
    173. 

  173. </DD>
    174. 

  174. </DL>
    175. 

  175. <HR>
    176. 

  176. 

  177. <A NAME="setStatus(java.lang.String)"><!-- --></A><H3>
    178. 

  178. setStatus</H3>
    179. 

  179. <PRE>
    180. 

  180. void <B>setStatus</B>(java.lang.String&nbsp;status)</PRE>
    181. 

  181. <DL>
    182. 

  182. <DD>Update the status label.
    183. 

  183. <P>
    184. 

  184. <DD><DL>
    185. 

  185. <DT><B>Parameters:</B><DD><CODE>status</CODE> - the new status label<DT><B>Since:</B></DT>
    186. 

  186.   <DD>jEdit 4.3pre3</DD>
    187. 

  187. </DL>
    188. 

  188. </DD>
    189. 

  189. </DL>
    190. 

  190. <!-- ========= END OF CLASS DATA ========= -->
    191. 

  191. <HR>
    192. 

  192. 

  193. 

  194. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    195. 

  195. <A NAME="navbar_bottom"><!-- --></A>
    196. 

  196. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
    197. 

  197. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    198. 

  198. <TR>
    199. 

  199. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    200. 

  200. <A NAME="navbar_bottom_firstrow"><!-- --></A>
    201. 

  201. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    202. 

  202.   <TR ALIGN="center" VALIGN="top">
    203. 

  203.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    204. 

  204.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    205. 

  205.   <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    206. 

  206.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ProgressObserver.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    207. 

  207.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    208. 

  208.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    209. 

  209.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    210. 

  210.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    211. 

  211.   </TR>
    212. 

  212. </TABLE>
    213. 

  213. </TD>
    214. 

  214. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    215. 

  215. </EM>
    216. 

  216. </TD>
    217. 

  217. </TR>
    218. 

  218. 

  219. <TR>
    220. 

  220. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    221. 

  221. &nbsp;<A HREF="../../../../org/gjt/sp/util/Log.html" title="class in org.gjt.sp.util"><B>PREV CLASS</B></A>&nbsp;
    222. 

  222. &nbsp;<A HREF="../../../../org/gjt/sp/util/PropertiesBean.html" title="class in org.gjt.sp.util"><B>NEXT CLASS</B></A></FONT></TD>
    223. 

  223. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    224. 

  224.   <A HREF="../../../../index.html?org/gjt/sp/util/ProgressObserver.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    225. 

  225. &nbsp;<A HREF="ProgressObserver.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    226. 

  226. &nbsp;
    227. 

  227. <NOSCRIPT>
    228. 

  228.   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
    229. 

  229. </NOSCRIPT>
    230. 

  230. 

  231. 

  232. </FONT></TD>
    233. 

  233. </TR>
    234. 

  234. <TR>
    235. 

  235. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    236. 

  236.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
    237. 

  237. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    238. 

  238. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    239. 

  239. </TR>
    240. 

  240. </TABLE>
    241. 

  241. <A NAME="skip-navbar_bottom"></A>
    242. 

  242. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    243. 

  243. 

  244. <HR>
    245. 

  245. 

  246. </BODY>
    247. 

  247. </HTML>
    248. 

  248.