csbase.client.desktop

Class DesktopTask

java.lang.Object

csbase.client.desktop.DesktopTask

All Implemented Interfaces:

java.lang.Runnable

public abstract class DesktopTask
extends java.lang.Object
implements java.lang.Runnable

A classe DesktopTask modela uma tarefa possivelmente demorada executada no cliente (tipicamente uma chamada remota ao servidor). Uma thread é criada para a execução da tarefa, para que eventos de interface (como redesenho) possam ser atendidos. As interações de teclado e mouse, contudo, são bloqueadas. Caso a duração da tarefa ultrapasse um valor limite (1 seg), um diálogo (modal) contendo uma barra de progresso será exibido. Este diálogo será fechado automaticamente ao final da tarefa.

Author:

Tecgraf/PUC-Rio

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Exception	exception Exceção gerada pela tarefa
protected java.lang.Object	result Resultado gerado pela tarefa
protected java.lang.String	taskTitle Título da tarefa

Constructor Summary

Constructors

Constructor and Description
DesktopTask()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Exception	getException() Obtém a exceção gerada pela tarefa.
java.lang.Object	getResult() Obtém o valor de resultado da tarefa executada.
protected abstract void	performTask() Tarefa a ser executada.
void	run()
void	setProgressStatus(int perc) Ajuste do percentual
protected void	setResult(java.lang.Object result) Coloca o valor de resultado da tarefa executada.
void	setStepText(java.lang.String text) Ajuste do texto de passo.
void	setUnknownStatus()
void	start(java.awt.Window parentWindow, java.lang.String title, java.lang.String taskMessage) Inicia a execução da tarefa.
boolean	succeeded() Verifica se a tarefa foi concluida com sucesso; este método será tipicamente redefinido nas especializações de DesktopTask.

Methods inherited from class java.lang.Object

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

Field Detail

result

protected java.lang.Object result

Resultado gerado pela tarefa

exception

protected java.lang.Exception exception

Exceção gerada pela tarefa

taskTitle

protected java.lang.String taskTitle

Título da tarefa

Constructor Detail

DesktopTask

public DesktopTask()

Method Detail

performTask

protected abstract void performTask()
                             throws java.lang.Exception

Tarefa a ser executada.

Throws:

java.lang.Exception - exceção.

run

public void run()

Specified by:

run in interface java.lang.Runnable

getException

public java.lang.Exception getException()

Obtém a exceção gerada pela tarefa.

Returns:

a exceção

setResult

protected void setResult(java.lang.Object result)

Coloca o valor de resultado da tarefa executada.

Parameters:

result - o valor de resultado da tarefa

getResult

public java.lang.Object getResult()

Obtém o valor de resultado da tarefa executada. Este método será tipicamente redefinido nas especializações de DesktopTask.

Returns:

o valor de resultado da tarefa

succeeded

public boolean succeeded()

Verifica se a tarefa foi concluida com sucesso; este método será tipicamente redefinido nas especializações de DesktopTask.

Returns:

true em caso de sucesso, false caso contrário.

setStepText

public void setStepText(java.lang.String text)

Ajuste do texto de passo.

Parameters:

text - o texto

setProgressStatus

public void setProgressStatus(int perc)

Ajuste do percentual

Parameters:

perc - o percentual

setUnknownStatus

public void setUnknownStatus()

start

public void start(java.awt.Window parentWindow,
         java.lang.String title,
         java.lang.String taskMessage)

Inicia a execução da tarefa.

Parameters:

parentWindow - janela base a partir da qual a da tarefa foi comandada

title - título do diálogo de progresso (caso seja exibido)

taskMessage - mensagem no diálogo de progresso (caso seja exibido)