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

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

Wizard(Class<?> firstStepClass, List<?> stepGroupList)
Cria um wizard que pode ser fechado e cancelado.

Wizard(Class<?> firstStepClass, List<?> stepGroupList, Map<?,?> globalData)
Cria um wizard que pode ser fechado e cancelado.

Wizard(Class<?> firstStepClass, List<?> stepGroupList, Map<?,?> requisites, Object stepData)
Cria um wizard que pode ser fechado e cancelado.

Wizard(Class<?> firstStepClass, List<?> stepGroupList, Map<?,?> globalData, Object stepData, Wizard.FinishingType wizardType, boolean equalizeButtons, boolean resetHistoryOnChange)
Cria um wizard.

Wizard(Class<?> firstStepClass, List<?> stepGroupList, Map<?,?> globalData, Wizard.FinishingType wizardType, boolean equalizeButtons)
Cria um wizard.

Wizard(Class<?> firstStepClass, List<?> stepGroupList, Map<?,?> globalData, Wizard.FinishingType wizardType, boolean equalizeButtons, boolean hideFinishButtonsWhenDisabled)
Cria um wizard.

Wizard(Class<?> firstStepClass, List<?> stepGroupList, Object stepData)
Cria um wizard que pode ser fechado e cancelado.

Wizard(Class<?> firstStepClass, List<?> stepGroupList, Object stepData, Wizard.FinishingType wizardType)
Cria um wizard.

Wizard(Class<?> firstStepClass, List<?> stepGroupList, Object stepData, Wizard.FinishingType wizardType, boolean resetHistoryOnchange)
Cria um wizard.

Wizard(Class<?> firstStepClass, List<?> stepGroupList, Wizard.FinishingType wizardType)
Cria um wizard.

Wizard(Class<?> firstStepClass, List<?> stepGroupList, Wizard.FinishingType wizardType, boolean equalizeButtons)
Cria um wizard.

Wizard(Class<?> firstStepClass, List<?> stepGroupList, Wizard.FinishingType wizardType, boolean equalizeButtons, boolean hideFinishButtonsWhenDisabled)
Cria um wizard.

Method Summary

void	addListener(WizardListener listener) Adiciona um ouvinte à lista de ouvintes do wizard.
static void	equalizeButtonSizes(JButton[] buttons) Iguala o tamanho dos botões contidos no array passado como parâmetro.
protected Step	getStep(Class<?> stepClass) Recupera um passo
void	hideFollowStepPanel() Recolhe o painel de instruções
boolean	isFollowStepPanelHidden()
void	removeListener(WizardListener listener) Remove um ouvinte da lista de ouvintes do wizard.
void	setCanSkipSteps(boolean canSkipSteps) Habilita/desabilita o salto de passos.
void	setMinHeight(int height) Atribui uma nova altura mínima para o wizard
void	setMinWidth(int width) Atribui uma nova largura mínima para o wizard
void	setStepInstructionTextAreaFont(Font font) Configura a fonte utilizada na caixa de texto da instrução do passo
void	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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, transferFocusBackward, 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, hide, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

Wizard

public Wizard(Class<?> firstStepClass,
              List<?> stepGroupList)

Cria um wizard que pode ser fechado e cancelado.

Parameters:

firstStepClass - A classe do primeiro passo do wizard.

stepGroupList - A lista de grupos de passos.

Wizard

public Wizard(Class<?> firstStepClass,
              List<?> stepGroupList,
              Wizard.FinishingType wizardType)

Cria um wizard.

Parameters:

firstStepClass - A classe do primeiro passo.

stepGroupList - A lista de grupos de passos.

wizardType - O tipo de finalização suportada pelo wizard.

Wizard

public Wizard(Class<?> firstStepClass,
              List<?> stepGroupList,
              Wizard.FinishingType wizardType,
              boolean equalizeButtons)

Cria um wizard.

Parameters:

firstStepClass - A classe do primeiro passo.

stepGroupList - A lista de grupos de passos.

wizardType - O tipo de finalização suportada pelo wizard.

equalizeButtons - Indica se o tamanho dos botões do wizard deve ser equalizado

Wizard

public Wizard(Class<?> firstStepClass,
              List<?> stepGroupList,
              Wizard.FinishingType wizardType,
              boolean equalizeButtons,
              boolean hideFinishButtonsWhenDisabled)

Cria um wizard.

Parameters:

firstStepClass - A classe do primeiro passo.

stepGroupList - A lista de grupos de passos.

wizardType - O tipo de finalização suportada pelo wizard.

equalizeButtons - Indica se o tamanho dos botões do wizard deve ser equalizado

hideFinishButtonsWhenDisabled - Indica se os botões Fechar, Cancelar e Confirmar permanecerão visiveis mesmo quando desabilitados

Wizard

public Wizard(Class<?> firstStepClass,
              List<?> stepGroupList,
              Map<?,?> globalData)

Cria um wizard que pode ser fechado e cancelado.

Parameters:

firstStepClass - A classe do primeiro passo do wizard.

stepGroupList - A lista de grupos de passos.

globalData - Dados globais a serem inseridos no histórico do wizard.

Wizard

public Wizard(Class<?> firstStepClass,
              List<?> stepGroupList,
              Object stepData,
              Wizard.FinishingType wizardType,
              boolean resetHistoryOnchange)

Cria um wizard.

Com os dados recebidos, é possível iniciar o wizard num passo posterior ao primeiro passo.

Parameters:

firstStepClass - A classe do primeiro passo.

stepGroupList - A lista de grupos de passos.

stepData - Os dados a serem traduzidos pelos passos.

wizardType - O tipo de finalização suportada pelo wizard.

resetHistoryOnchange - true para limpar o histórico caso o passo seja alterado e tenha havido um retrocesso

Wizard

public Wizard(Class<?> firstStepClass,
              List<?> stepGroupList,
              Object stepData,
              Wizard.FinishingType wizardType)

Cria um wizard.

Com os dados recebidos, é possível iniciar o wizard num passo posterior ao primeiro passo.

Parameters:

firstStepClass - A classe do primeiro passo.

stepGroupList - A lista de grupos de passos.

stepData - Os dados a serem traduzidos pelos passos.

wizardType - O tipo de finalização suportada pelo wizard.

Wizard

public Wizard(Class<?> firstStepClass,
              List<?> stepGroupList,
              Map<?,?> requisites,
              Object stepData)

Cria um wizard que pode ser fechado e cancelado.

Com os dados recebidos, é possível iniciar o wizard num passo posterior ao primeiro passo.

Parameters:

firstStepClass - A classe do primeiro passo do wizard.

stepGroupList - A lista de grupos de passos.

requisites - Dados globais a serem inseridos no histórico do wizard.

stepData - Os dados a serem traduzidos pelos passos.

Wizard

public Wizard(Class<?> firstStepClass,
              List<?> stepGroupList,
              Object stepData)

Cria um wizard que pode ser fechado e cancelado.

Com os dados recebidos, é possível iniciar o wizard num passo posterior ao primeiro passo.

Parameters:

firstStepClass - A classe do primeiro passo do wizard.

stepGroupList - A lista de grupos de passos.

stepData - Os dados a serem traduzidos pelos passos.

Wizard

public Wizard(Class<?> firstStepClass,
              List<?> stepGroupList,
              Map<?,?> globalData,
              Wizard.FinishingType wizardType,
              boolean equalizeButtons)

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.

wizardType - O tipo de finalização suportada pelo wizard.

equalizeButtons - Indica se o tamanho dos botões do wizard deve ser equalizado

Wizard

public Wizard(Class<?> firstStepClass,
              List<?> stepGroupList,
              Map<?,?> globalData,
              Wizard.FinishingType wizardType,
              boolean equalizeButtons,
              boolean hideFinishButtonsWhenDisabled)

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.

wizardType - O tipo de finalização suportada pelo wizard.

equalizeButtons - Indica se o tamanho dos botões do wizard deve ser equalizado

hideFinishButtonsWhenDisabled - Indica se os botões Fechar, Cancelar e Confirmar permanecerão visiveis mesmo quando desabilitados

Wizard

public Wizard(Class<?> firstStepClass,
              List<?> stepGroupList,
              Map<?,?> globalData,
              Object stepData,
              Wizard.FinishingType wizardType,
              boolean equalizeButtons,
              boolean resetHistoryOnChange)

Cria um wizard.

Com os dados recebidos, é possível iniciar o wizard num passo posterior ao primeiro passo.

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.

stepData - Os dados a serem traduzidos pelos passos.

wizardType - O tipo de finalização suportada pelo wizard.

equalizeButtons - Indica se o tamanho dos botões do wizard deve ser equalizado

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.

equalizeButtonSizes

public static void equalizeButtonSizes(JButton[] buttons)

Iguala o tamanho dos botões contidos no array passado como parâmetro.

Parameters:

buttons - o array com os botões

setStepInstructionTextAreaFont

public void 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

getStep

protected Step getStep(Class<?> 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 void setCanSkipSteps(boolean canSkipSteps)

Habilita/desabilita o salto de passos.

Parameters:

canSkipSteps -

setMinHeight

public void setMinHeight(int height)

Atribui uma nova altura mínima para o wizard

Parameters:

height - a nova altura

setMinWidth

public void setMinWidth(int width)

Atribui uma nova largura mínima para o wizard

Parameters:

width - a nova largura

isFollowStepPanelHidden

public boolean isFollowStepPanelHidden()

Returns:

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

hideFollowStepPanel

public void hideFollowStepPanel()

Recolhe o painel de instruções

showFollowStepPanel

public void showFollowStepPanel()

Exibe o painel de instruções