站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > JavaTM 2 Platform Standard Edition 5.0 API 规范中文版

ProgressMonitor (Java 2 Platform SE 5.0) - JavaTM 2 Platform Standard Edition 5.0 API 规范中文版

JavaTM 2 Platform
Standard Ed. 5.0

javax.swing
类 ProgressMonitor

java.lang.Object
  继承者 javax.swing.ProgressMonitor
所有已实现的接口:
Accessible

public class ProgressMonitor
extends Object
implements Accessible

监视某个操作的进度的类。如果表现为操作需要一段时间,则会弹出进度对话框。创建 ProgressMonitor 时,向它提供数字范围和描述字符串。在操作进行时,调用 setProgress 方法,以指示操作的 [min,max] 范围有多大。最初,不存在 ProgressDialog。第一个 millisToDecideToPopup 毫秒(默认值为 500)以后,进度监视器会预测该操作将花费多长时间。如果大于 millisToPopup(默认值为 2000,即 2 秒),则弹出 ProgressDialog。

当可以看到 Dialog 框时,调用 setProgress 可以更新进度条。setProgress 并不总是更新该进度条,仅当进度量明显增多时才进行更新。

有关此内容的更多文档和示例,请参阅《The Java Tutorial》中的 How to Monitor Progress 一节。

另请参见:
ProgressMonitorInputStream

嵌套类摘要
protected  class ProgressMonitor.AccessibleProgressMonitor
          AccessibleProgressMonitor 实现 ProgressMonitor 类的可访问性支持。
 
字段摘要
protected  AccessibleContext accessibleContext
           
 
构造方法摘要
ProgressMonitor(Component parentComponent, Object message, String note, int min, int max)
          构造一个图形对象,它一般会根据进程的完成情况通过填充矩形条来显示进度。
 
方法摘要
 void close()
          指示操作已完成。
 AccessibleContext getAccessibleContext()
          获得 ProgressMonitorAccessibleContext
 int getMaximum()
          返回最大值 - 进度值的较高端。
 int getMillisToDecideToPopup()
          返回在确定是否弹出进度监视器之前此对象等待的时间量。
 int getMillisToPopup()
          返回显示弹出监视器花费的时间量。
 int getMinimum()
          返回最小值 - 进度值的较低端。
 String getNote()
          指定随进度消息一起显示的其他注释。
 boolean isCanceled()
          如果用户单击进度对话框中的 Cancel 按钮,则返回 true。
 void setMaximum(int m)
          指定最大值。
 void setMillisToDecideToPopup(int millisToDecideToPopup)
          指定在确定是否弹出进度监视器之前要等待的时间量。
 void setMillisToPopup(int millisToPopup)
          指定显示弹出监视器花费的时间量。
 void setMinimum(int m)
          指定最小值。
 void setNote(String note)
          指定与进度消息一起显示的其他注释。
 void setProgress(int nv)
          指示正被监视操作的进度。
 
从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

字段详细信息

accessibleContext

protected AccessibleContext accessibleContext
构造方法详细信息

ProgressMonitor

public ProgressMonitor(Component parentComponent,
                       Object message,
                       String note,
                       int min,
                       int max)
构造一个图形对象,它一般会根据进程的完成情况通过填充矩形条来显示进度。

参数:
parentComponent - 对话框的父组件
message - 要显示给用户的描述消息,以指示在监视什么操作。这不随操作进度而更改。请参阅 JOptionPane.message 中方法的 message 参数,了解值的范围。
note - 描述操作状态的简短注释。随着操作的进行,可以调用 setNote 来更改显示的注释。例如,这可用于迭代文件列表以显示正在处理的文件名称的操作中。如果注释最初为 null,则对话框中将不存在注释行,并且 setNote 无效
min - 范围的下边界
max - 范围的上边界
另请参见:
JDialog, JOptionPane
方法详细信息

setProgress

public void setProgress(int nv)
指示正被监视操作的进度。如果指定值 >= 最大值,则关闭进度监视器。

参数:
nv - 指定当前值的 int,位于为此组件指定的最大值和最小值之间
另请参见:
setMinimum(int), setMaximum(int), close()

close

public void close()
指示操作已完成。当 setProgress 设置的值 >= 最大值时,此过程自动发生,但是如果提前结束该操作,则可以提前调用它。


getMinimum

public int getMinimum()
返回最小值 - 进度值的较低端。

返回:
表示最小值的 int
另请参见:
setMinimum(int)

setMinimum

public void setMinimum(int m)
指定最小值。

参数:
m - 指定最小值的 int
另请参见:
getMinimum()

getMaximum

public int getMaximum()
返回最大值 - 进度值的较高端。

返回:
表示最大值的 int
另请参见:
setMaximum(int)

setMaximum

public void setMaximum(int m)
指定最大值。

参数:
m - 指定最大值的 int #getMaximum

isCanceled

public boolean isCanceled()
如果用户单击进度对话框中的 Cancel 按钮,则返回 true。


setMillisToDecideToPopup

public void setMillisToDecideToPopup(int millisToDecideToPopup)
指定在确定是否弹出进度监视器之前要等待的时间量。

参数:
millisToDecideToPopup - 指定要等待的时间(以毫秒为单位)的 int
另请参见:
getMillisToDecideToPopup()

getMillisToDecideToPopup

public int getMillisToDecideToPopup()
返回在确定是否弹出进度监视器之前此对象等待的时间量。

另请参见:
setMillisToDecideToPopup(int)

setMillisToPopup

public void setMillisToPopup(int millisToPopup)
指定显示弹出监视器花费的时间量。(如果剩余的预计时间小于此时间,则不显示弹出监视器。)

参数:
millisToPopup - 指定时间(以毫秒为单位)的 int
另请参见:
getMillisToPopup()

getMillisToPopup

public int getMillisToPopup()
返回显示弹出监视器花费的时间量。

另请参见:
setMillisToPopup(int)

setNote

public void setNote(String note)
指定与进度消息一起显示的其他注释。例如,在复制多个文件的过程中,用于显示当前正在复制哪一个文件。

参数:
note - 指定要显示的注释的 String
另请参见:
getNote()

getNote

public String getNote()
指定随进度消息一起显示的其他注释。

返回:
指定要显示的注释的 String
另请参见:
setNote(java.lang.String)

getAccessibleContext

public AccessibleContext getAccessibleContext()
获得 ProgressMonitorAccessibleContext

指定者:
接口 Accessible 中的 getAccessibleContext
返回:
ProgressMonitorAccessibleContext
从以下版本开始:
1.5

JavaTM 2 Platform
Standard Ed. 5.0

提交错误或意见
有关更多的 API 参考资料和开发人员文档,请参阅 Java 2 SDK SE 开发人员文档。该文档包含更详细的、面向开发人员的描述,以及总体概述、术语定义、使用技巧和工作代码示例。

版权所有 2004 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策