tecgraf.javautils.gui.wizard

Class Wizard

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

tecgraf.javautils.gui.wizard.Wizard

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public final class Wizard
extends JPanel

Representa um wizard (assistente) para a obtenção de dados do usuário e, posteriormente, execução de uma ação.

Author:

Tecgraf/PUC-Rio

See Also:

WizardSample, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Wizard.FinishingType Define os tipos de finalização suportados.

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
Wizard(Class<? extends Step> firstStepClass, List<StepGroup> stepGroupList, Map<String,Object> globalData, Object stepData, Wizard.FinishingType finishingType, boolean resetHistoryOnChange) Cria um wizard.

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(WizardListener listener) Adiciona um ouvinte à lista de ouvintes do wizard.
boolean	canSkipSteps() Consulta o salto de passos.
protected Step	getStep(Class<? extends Step> stepClass) Recupera um passo
Wizard	hideFollowStepPanel() Recolhe o painel de instruções
boolean	isFollowStepPanelHidden()
boolean	isHideFinishButtonsWhenDisabled() Consulta indicativo de ocultação de botões de término no caso de ficarem desabilitados.
void	removeListener(WizardListener listener) Remove um ouvinte da lista de ouvintes do wizard.
Wizard	setCanSkipSteps(boolean canSkipSteps) Habilita/desabilita o salto de passos.
Wizard	setHideFinishButtonsWhenDisabled(boolean flag) Ajusta indicativo de ocultação de botões de término no caso de ficarem desabilitados.
Wizard	setMinHeight(int height) Atribui uma nova altura mínima para o wizard
Wizard	setMinWidth(int width) Atribui uma nova largura mínima para o wizard
Wizard	setStepInstructionTextAreaFont(Font font) Configura a fonte utilizada na caixa de texto da instrução do passo
Wizard	showFollowStepPanel() Exibe o painel de instruções

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

Wizard

public Wizard(Class<? extends Step> firstStepClass,
      List<StepGroup> stepGroupList,
      Map<String,Object> globalData,
      Object stepData,
      Wizard.FinishingType finishingType,
      boolean resetHistoryOnChange)

Cria um wizard.

Parameters:

firstStepClass - A classe do primeiro passo.

stepGroupList - A lista de grupos de passos.

globalData - Dados globais a serem inseridos no histórico do wizard (se for passado null, assume-se um mapa de dados vazio).

stepData - Os dados a serem traduzidos pelos passos (pode ser null e significa que não serão feitas traduções).

finishingType - O tipo de finalização suportada pelo wizard (não pode ser null).

resetHistoryOnChange - indica se o histórico será limpo em caso de retrocesso do wizard e mudança dos dados

Method Detail

addListener

public void addListener(WizardListener listener)

Adiciona um ouvinte à lista de ouvintes do wizard.

Parameters:

listener - O ouvinte a ser adicionado.

removeListener

public void removeListener(WizardListener listener)

Remove um ouvinte da lista de ouvintes do wizard.

Parameters:

listener - O ouvinte a ser removido.

setStepInstructionTextAreaFont

public Wizard setStepInstructionTextAreaFont(Font font)

Configura a fonte utilizada na caixa de texto da instrução do passo

Parameters:

font - nova fonte a ser utilizada na caixa de texto de instruções

Returns:

wizard;

getStep

protected Step getStep(Class<? extends Step> stepClass)

Recupera um passo

Parameters:

stepClass - A classe do passo

Returns:

A instância do passo, null se o passo não existir

setCanSkipSteps

public Wizard setCanSkipSteps(boolean canSkipSteps)

Habilita/desabilita o salto de passos.

Parameters:

canSkipSteps -

Returns:

wizard

canSkipSteps

public boolean canSkipSteps()

Consulta o salto de passos.

Returns:

indicativo

setMinHeight

public Wizard setMinHeight(int height)

Atribui uma nova altura mínima para o wizard

Parameters:

height - a nova altura

Returns:

wizard

setMinWidth

public Wizard setMinWidth(int width)

Atribui uma nova largura mínima para o wizard

Parameters:

width - a nova largura

Returns:

wizard

isFollowStepPanelHidden

public boolean isFollowStepPanelHidden()

Returns:

true se o painel de instruções estiver recolhido, false caso contrário

hideFollowStepPanel

public Wizard hideFollowStepPanel()

Recolhe o painel de instruções

Returns:

wizard

showFollowStepPanel

public Wizard showFollowStepPanel()

Exibe o painel de instruções

Returns:

wizard

isHideFinishButtonsWhenDisabled

public boolean isHideFinishButtonsWhenDisabled()

Consulta indicativo de ocultação de botões de término no caso de ficarem desabilitados.

Returns:

indicativo

setHideFinishButtonsWhenDisabled

public Wizard setHideFinishButtonsWhenDisabled(boolean flag)

Ajusta indicativo de ocultação de botões de término no caso de ficarem desabilitados.

Parameters:

flag - indicativo

Returns:

wizard