com.ds.common.swing.progress

类 Task

java.lang.Object

com.ds.common.swing.progress.Task

直接已知子类:

CreateVersionTask, OpenProcessTask

public abstract class Task
extends Object

Title: 常用代码打包

Description: This is the parent class of what performs a time consuming task. It can also interract with ProgressDialog to monitor the process of the task.

Copyright: Copyright (c) 2006

Company: www.justdos.net

版本:

1.0

作者:

wenzhang li

构造器概要

构造器

构造器和说明
Task()

方法概要

限定符和类型	方法和说明
abstract void	cancel() Invoked by ProgressDialog when the task is canceled or an error occured.
abstract void	complete() Invoked by ProgressDialog when the task is completed.
boolean	done() ProgressDialog use this method to adjust whether the task has done.
int	getCurrent() Gets the current attribute of the Task object
boolean	getHasError() ProgressDialog will timely check the return value of this method to adjust whether an error accured.
int	getLengthOfTask() Gets the lengthOfTask attribute of the Task object
String	getMessage() Gets the message attribute of the Task object
abstract void	go() Sample: public void go() { final SwingWorker worker = new SwingWorker() { public Object construct() { // time consuming task here...
void	setCurrent(int current) Sets the current attribute of the Task object
void	setHasError(boolean hasError) If you catch an Exception or have other reason to stop the task and not regard it as completed, pass true to this method.
void	setLengthOfTask(int lengthOfTask) Sets the lengthOfTask attribute of the Task object
void	setMessage(String statMessage) Sets the message attribute of the Task object
void	stop() Stop this task.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

Task

public Task()

方法详细资料

go

public abstract void go()

Sample:

public void go() {
final SwingWorker worker = new SwingWorker() {
public Object construct() {
// time consuming task here...

// return a Object class that SwingWorker needed
return new Object();
}}}

This method is invoked by the user when the task wanna to start.

cancel

public abstract void cancel()

Invoked by ProgressDialog when the task is canceled or an error occured.

complete

public abstract void complete()

Invoked by ProgressDialog when the task is completed.

stop

public void stop()

Stop this task. If you wanna stop the task and regard it as completed, invoke it.

setHasError

public void setHasError(boolean hasError)

If you catch an Exception or have other reason to stop the task and not regard it as completed, pass true to this method.

参数:

hasError - The new hasError value

getHasError

public boolean getHasError()

ProgressDialog will timely check the return value of this method to adjust whether an error accured. If so, ProgressDialog will invoke the task's cancel method and display an error message according the getMessage()'s return value.

返回:

The hasError value

done

public boolean done()

ProgressDialog use this method to adjust whether the task has done.

返回:

Description of the Return Value

getLengthOfTask

public int getLengthOfTask()

Gets the lengthOfTask attribute of the Task object

返回:

The lengthOfTask value

setLengthOfTask

public void setLengthOfTask(int lengthOfTask)

Sets the lengthOfTask attribute of the Task object

参数:

lengthOfTask - The new lengthOfTask value

getCurrent

public int getCurrent()

Gets the current attribute of the Task object

返回:

The current value

setCurrent

public void setCurrent(int current)

Sets the current attribute of the Task object

参数:

current - The new current value

getMessage

public String getMessage()

Gets the message attribute of the Task object

返回:

The message value

setMessage

public void setMessage(String statMessage)

Sets the message attribute of the Task object

参数:

statMessage - The new message value