tecgraf.javautils.gui.wizard
Class Step

java.lang.Object
  tecgraf.javautils.gui.wizard.Step

public abstract class Step
extends Object

Representa um passo de um wizard.

Author:

Tecgraf/PUC-Rio

Nested Class Summary

static class

Step.ConfirmOperation Representa a operação que será realizada após o usuário confirmar um passo.

Constructor Summary

protected	Step() Cria um passo.
protected	Step(Step.ConfirmOperation confirmOperation) Cria um passo.

Method Summary

void	addListener(StepListener listener) Adiciona um listener interessado em eventos do passo.
protected abstract boolean	canCancel() Define se o passo pode ser cancelado.
protected void	cancel() Realiza a ação de cancelamento de um passo e consequentemente do wizard.
protected abstract boolean	canClose() Define se o passo pode ser fechado.
protected abstract boolean	canConfirm() Define se o passo pode ser confirmado.
protected boolean	canGoNext(History history) Verifica se é possível ir para o próximo passo.
protected boolean	canGoPrevious() Verifica se é possível ir para o passo anterior.
protected void	close() Realiza a ação de fechamento de um passo e saída do wizard.
protected Object	confirm(History history) Realiza a ação de confirmação de um passo e saída do wizard.
protected abstract void	enter(History history) É executado sempre que se entra num passo.
protected abstract void	exit(History history) É executado sempre ao passar para o próximo passo ou para o passo anterior.
protected abstract String	getConfirmActionName() Obtém o nome da ação de confirmação.
protected abstract String	getConfirmActionTooltip() Obtém a dica da ação de confirmação.
protected Step.ConfirmOperation	getConfirmOperation() Obtém a operação de confirmação.
protected abstract Container	getContainer() Obtém o container do passo.
protected abstract String	getInstruction() Obtém as instruções para utilização do passo.
protected abstract Class<?>	getNext(History history) Obtém a classe do próximo passo.
protected Step	getPrevious() Obtém o passo anterior.
protected abstract String	getTitle() Obtém o título do passo.
protected boolean	hasNext(History history) Verifica se o passo possui próximo passo.
protected boolean	hasPrevious() Verifica se o passo possui passo anterior.
protected abstract boolean	isReady() Verifica se o passo está pronto.
protected abstract boolean	isTranslationCompleted(History history) Verifica se o passo conseguiu obter todos os dados necessários no processo de tradução.
protected void	notifyChanged() Notifica aos eventos que o passo foi alterado.
void	removeListener(StepListener listener) Remove um listener que estava interessado em eventos do passo.
protected void	setConfirmOperation(Step.ConfirmOperation operation) Define a ação a ser realizada ao se confirmar o passo.
protected abstract void	translate(History history, Object data) Obtém os dados presentes em data que pertencem ao passo e os insere no histórico.

Methods inherited from class java.lang.Object

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

Constructor Detail

Step

protected Step()

Cria um passo.

Step

protected Step(Step.ConfirmOperation confirmOperation)

Cria um passo.

Parameters:

confirmOperation - A operação que será realizada após a confirmação do passo.

Method Detail

addListener

public final void addListener(StepListener listener)

Adiciona um listener interessado em eventos do passo.

Parameters:

listener - O listener.

removeListener

public final void removeListener(StepListener listener)

Remove um listener que estava interessado em eventos do passo.

Parameters:

listener - O listener.

canClose

protected abstract boolean canClose()

Define se o passo pode ser fechado.

Returns:

true, caso seja possível fechar o passo, ou false, caso contrário.

canCancel

protected abstract boolean canCancel()

Define se o passo pode ser cancelado.

Returns:

true, caso seja possível cancelar o passo, ou false, caso contrário.

canConfirm

protected abstract boolean canConfirm()

Define se o passo pode ser confirmado.

Returns:

true, caso seja possível confirmar o passo, ou false, caso contrário.

enter

protected abstract void enter(History history)
                       throws WizardException

É executado sempre que se entra num passo.

Parameters:

history - O histórico.

Throws:

WizardException - Caso haja algum problema com o passo.

exit

protected abstract void exit(History history)

É executado sempre ao passar para o próximo passo ou para o passo anterior.

Parameters:

history - O histórico.

getConfirmActionName

protected abstract String getConfirmActionName()

Obtém o nome da ação de confirmação.

Returns:

O nome da ação de confirmação. Pode ser nulo, caso o passo não seja de confirmação.

getConfirmActionTooltip

protected abstract String getConfirmActionTooltip()

Obtém a dica da ação de confirmação.

Returns:

A dica da ação de confirmação. Pode ser nula, caso o passo não seja de confirmação.

getContainer

protected abstract Container getContainer()

Obtém o container do passo.

Returns:

O container.

getInstruction

protected abstract String getInstruction()

Obtém as instruções para utilização do passo. São exibidas acima do passo.

Returns:

As instruções para utilização do passo.

getNext

protected abstract Class<?> getNext(History history)

Obtém a classe do próximo passo.

Parameters:

history - O histórico.

Returns:

A classe do próximo passo, ou null, caso não exista próximo passo.

getTitle

protected abstract String getTitle()

Obtém o título do passo. É exibido acima das instruções.

Returns:

O título.

isReady

protected abstract boolean isReady()

Verifica se o passo está pronto. Esse método é usado para verificar se é possível ir para o próximo passo.

Returns:

true, caso o passo esteja pronto, ou false, caso contrário.

translate

protected abstract void translate(History history,
                                  Object data)

Obtém os dados presentes em data que pertencem ao passo e os insere no histórico.

Parameters:

history - O histórico.

data - Os dados.

isTranslationCompleted

protected abstract boolean isTranslationCompleted(History history)

Verifica se o passo conseguiu obter todos os dados necessários no processo de tradução.

Parameters:

history - O histórico.

Returns:

true, caso a tradução esteja completa, ou false, caso contrário.

close

protected void close()
              throws WizardException

Realiza a ação de fechamento de um passo e saída do wizard.

Throws:

WizardException - Caso haja algum problema com o passo.

cancel

protected void cancel()
               throws WizardException

Realiza a ação de cancelamento de um passo e consequentemente do wizard.

Throws:

WizardException - Caso haja algum problema com o passo.

confirm

protected Object confirm(History history)
                  throws WizardException

Realiza a ação de confirmação de um passo e saída do wizard.

Parameters:

history - O histórico.

Returns:

O resultado da confirmação.

Throws:

WizardException - Caso haja algum problema com o passo.

canGoPrevious

protected boolean canGoPrevious()

Verifica se é possível ir para o passo anterior.

Returns:

true, caso seja possível ir para o passo anterior, ou false, caso contrário.

canGoNext

protected boolean canGoNext(History history)

Verifica se é possível ir para o próximo passo.

Este método é chamado para habilitar/desabilitar o botão próximo quando o wizard entra em um passo ou quando existe alguma atualização nos listeners e não deve ser usado como validação de um passo. Para validar se o wizard pode ou não seguir para o próximo passo, deve-se usar os listeners listados no pacote tecgraf.javautils.gui.wizard

Parameters:

history - O histórico.

Returns:

true, caso seja possível ir para o próximo passo, ou false, caso contrário.

getConfirmOperation

protected final Step.ConfirmOperation getConfirmOperation()

Obtém a operação de confirmação.

Returns:

A operação de confirmação.

getPrevious

protected final Step getPrevious()

Obtém o passo anterior.

Returns:

O passo anterior.

hasNext

protected final boolean hasNext(History history)

Verifica se o passo possui próximo passo.

Parameters:

history - .

Returns:

true, caso possua próximo passo, ou false, caso contrário.

hasPrevious

protected final boolean hasPrevious()

Verifica se o passo possui passo anterior.

Returns:

true, caso possua passo anterior, ou false, caso contrário.

notifyChanged

protected final void notifyChanged()

Notifica aos eventos que o passo foi alterado.

setConfirmOperation

protected final void setConfirmOperation(Step.ConfirmOperation operation)

Define a ação a ser realizada ao se confirmar o passo.

Parameters:

operation - A operação a ser realizada.

Throws:

IllegalArgumentException - Caso a operação recebida esteja nula.