tecgraf.javautils.gui.wizard

Class History

java.lang.Object

tecgraf.javautils.gui.wizard.History

All Implemented Interfaces:

IStepListener, IWizardListener

public final class History
extends Object
implements IWizardListener, IStepListener

Representa um histórico de dados coletados pelo Wizard.

Cada dado coletado pertence a um passo (o passo onde foi coletado). Os passos têm acesso aos seus dados e aos dados dos passos anteriores.

Existe a possiblidade de se inserir dados globais, ou seja, dados pertencentes ao Wizard e que podem ser acessados por qualquer passo.

Author:

Tecgraf

Constructor Summary

Constructors

Constructor and Description
History(Wizard wizard, Class<? extends Step> firstStepClass, boolean resetHistoryOnChange) Cria um histórico.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Step step, String name, Object information) Adiciona um dado ao histórico.
void	addGlobal(Map<String,Object> globalData) Adiciona os dados recebidos nos dados globais do histórico.
void	addGlobal(String key, Object datum) Adiciona um dado global.
void	clearGlobalData() Limpa os dados globais.
boolean	contains(Step step, String name) Verifica se o histórico contém um dado acessível pelo passo especificado.
Object	get(Step step, String name) Obtém um dado acessível de um passo.
Object	getResult() Obtém o resultado do wizard.
void	remove(Step step, String name) Remove um dado acessível por um passo.
void	wasCancelled(Step step) É chamado quando o wizard é cancelado.
void	wasChanged(Step step) É chamado quando há alteração no estado de algum componente do passo.
void	wasClosed(Step step) É chamado quando o wizard é fechado.
void	wasConfirmed(Step step, Object object) É chamado quando o wizard é confirmado.
void	wasGoneNext(Step step, History history) É chamado quando o wizard vai para o próximo passo.
void	wasGonePrevious(Step step, History history) É chamado quando o wizard vai para o passo anterior.
void	wasHappenedException(Step step, WizardException exception) É chamado quando acontece uma exceção no wizard.

Methods inherited from class java.lang.Object

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

Constructor Detail

History

public History(Wizard wizard,
       Class<? extends Step> firstStepClass,
       boolean resetHistoryOnChange)

Cria um histórico.

Parameters:

wizard - A instância do wizard desse histórico

firstStepClass - classe do primeiro passo.

resetHistoryOnChange - true habilita reset do histórico em caso de mudança após um retrocesso no fluxo do wizard

Method Detail

add

public void add(Step step,
       String name,
       Object information)

Adiciona um dado ao histórico.

Parameters:

step - O passo dono do dado.

name - O nome do dado.

information - O dado, propriamente dito.

Throws:

IllegalArgumentException - Caso o passo seja nulo.

contains

public boolean contains(Step step,
               String name)

Verifica se o histórico contém um dado acessível pelo passo especificado.

Parameters:

step - O passo.

name - O nome do dado.

Returns:

true, caso exista o dado com o referido nome, ou false, caso contrário.

get

public Object get(Step step,
         String name)

Obtém um dado acessível de um passo.

Parameters:

step - O passo.

name - O nome do dado.

Returns:

O dado, ou null, caso não exista dado.

Throws:

IllegalArgumentException - Caso o nome do dado esteja nulo.

getResult

public Object getResult()

Obtém o resultado do wizard.

Returns:

O resultado.

remove

public void remove(Step step,
          String name)

Remove um dado acessível por um passo.

Parameters:

step - O passo.

name - O nome do dado a ser removido.

wasCancelled

public void wasCancelled(Step step)

É chamado quando o wizard é cancelado.

Specified by:

wasCancelled in interface IWizardListener

Parameters:

step - O passo onde o wizard foi cancelado.

wasClosed

public void wasClosed(Step step)

É chamado quando o wizard é fechado.

Specified by:

wasClosed in interface IWizardListener

Parameters:

step - O passo onde o wizard foi fechado.

wasConfirmed

public void wasConfirmed(Step step,
                Object object)

É chamado quando o wizard é confirmado.

Specified by:

wasConfirmed in interface IWizardListener

Parameters:

step - O passo onde o wizard foi confirmado.

object - O resultado da confirmação do passo.

wasGoneNext

public void wasGoneNext(Step step,
               History history)

É chamado quando o wizard vai para o próximo passo.

Specified by:

wasGoneNext in interface IWizardListener

Parameters:

step - O passo atual.

history - O histórico.

wasGonePrevious

public void wasGonePrevious(Step step,
                   History history)

É chamado quando o wizard vai para o passo anterior.

Specified by:

wasGonePrevious in interface IWizardListener

Parameters:

step - O passo atual.

history - O histórico.

wasHappenedException

public void wasHappenedException(Step step,
                        WizardException exception)

É chamado quando acontece uma exceção no wizard.

Specified by:

wasHappenedException in interface IWizardListener

Parameters:

step - O passo onde a exceção ocorreu.

exception - A exceção que ocorreu.

addGlobal

public void addGlobal(String key,
             Object datum)

Adiciona um dado global.

Parameters:

key - A chave que identificará o dado.

datum - O dado.

Throws:

IllegalArgumentException - Caso a chave ou o dado estejam nulos.

addGlobal

public void addGlobal(Map<String,Object> globalData)

Adiciona os dados recebidos nos dados globais do histórico.

Parameters:

globalData - Os dados a serem inseridos como globais.

Throws:

IllegalArgumentException - Caso o mapa de dados globais esteja nulo.

clearGlobalData

public void clearGlobalData()

Limpa os dados globais.

wasChanged

public final void wasChanged(Step step)

É chamado quando há alteração no estado de algum componente do passo.

Specified by:

wasChanged in interface IStepListener

Parameters:

step - O passo que foi alterado.