Package ipsk.awt

Class ProgressWorker

java.lang.Object

ipsk.awt.ProgressWorker

All Implemented Interfaces:

Worker, ProgressUpdate, java.lang.Runnable

Direct Known Subclasses:

DeleteDirectoryWorker, DemoWorker, UnzipWorker, URLContentLoader, URLMultiContentLoader, ZipPackerWorker

public abstract class ProgressWorker
extends java.lang.Object
implements Worker, ProgressUpdate, java.lang.Runnable

Worker class. Does some work in a separate thread in the doWork() method. Create a subclass and implement the the doWork() method.

Author:

klausj

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ProgressWorker.ProgressEventTransferAgent

Nested classes/interfaces inherited from interface ipsk.awt.Worker

Worker.State

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	generateEvents
protected ProgressWorker.ProgressEventTransferAgent	progressEventTransferAgent
protected ProgressStatus	progressStatus
protected Task	task
protected java.lang.Thread	thread
protected java.lang.String	threadName

Constructor Summary

Constructors

Constructor	Description
ProgressWorker()
ProgressWorker(java.lang.String threadName)

Method Summary

Modifier and Type	Method	Description
void	addProgressListener(ProgressListener progressListener)
void	cancel()
void	close()
protected void	doWork()
void	fireProgressEvent()
protected void	fireProgressEvent(ProgressEvent progressEvent)
ProgressStatus	getProgressStatus()
Worker.State	getStatus()
Task	getTask()
protected boolean	hasCancelRequest()
void	open()
void	removeProgressListener(ProgressListener progressListener)
void	reset()
void	run()
void	setRunningWithParentWorker()
void	setTask(Task task)
void	start()

Methods inherited from class java.lang.Object

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

Field Detail

progressEventTransferAgent

protected ProgressWorker.ProgressEventTransferAgent progressEventTransferAgent

threadName

protected java.lang.String threadName

generateEvents

protected volatile boolean generateEvents

thread

protected java.lang.Thread thread

progressStatus

protected volatile ProgressStatus progressStatus

task

protected Task task

Constructor Detail

ProgressWorker

public ProgressWorker()

ProgressWorker

public ProgressWorker(java.lang.String threadName)

Method Detail

getTask

public Task getTask()

setTask

public void setTask(Task task)

fireProgressEvent

public void fireProgressEvent()

Specified by:

fireProgressEvent in interface ProgressUpdate

fireProgressEvent

protected void fireProgressEvent(ProgressEvent progressEvent)

open

public void open()
          throws WorkerException

Specified by:

open in interface Worker

Throws:

WorkerException

start

public void start()

Specified by:

start in interface Worker

run

public void run()

Specified by:

run in interface java.lang.Runnable

setRunningWithParentWorker

public void setRunningWithParentWorker()

doWork

protected void doWork()
               throws WorkerException

Throws:

WorkerException

hasCancelRequest

protected boolean hasCancelRequest()

cancel

public void cancel()

Specified by:

cancel in interface Worker

getStatus

public Worker.State getStatus()

reset

public void reset()

close

public void close()
           throws WorkerException

Specified by:

close in interface Worker

Throws:

WorkerException

addProgressListener

public void addProgressListener(ProgressListener progressListener)

Specified by:

addProgressListener in interface Worker

removeProgressListener

public void removeProgressListener(ProgressListener progressListener)

Specified by:

removeProgressListener in interface Worker

getProgressStatus

public ProgressStatus getProgressStatus()

Specified by:

getProgressStatus in interface ProgressUpdate

Specified by:

getProgressStatus in interface Worker