Package org.gvsig.utils.swing.wizard

Class Wizard

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.gvsig.utils.swing.wizard.Wizard

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, WizardControl

public class Wizard
extends JPanel
implements WizardControl

Clase wizard con la gestión de los botones y los paneles añadidos al mismo. Al avanzar o retrasar un paso el asistente se desactivan todos los botones menos el de cancelar, que está activo siempre por defecto

Author:

Fernando González Cortés

See Also:

• Serialized Form

Nested Class Summary

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

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

accessibleContext, 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	Description
Wizard(String backText, String nextText, String finishText, String cancelText)	This is the default constructor

Method Summary

Modifier and Type	Method	Description
void	addStep(Step s)	Añade un paso al asistente.
void	addWizardListener(WizardListener listener)	Añade un lístener de eventos del wizard
void	backStep()	Muestra el panel del paso anterior del asistente
void	cancel()	Se cancela el asistente.
void	enableBack(boolean enabled)	Activa el paso al paso anterior del asistente
void	enableNext(boolean enabled)	Activa el paso al siguiente paso del asistente
void	finish()	Se finaliza el asistente.
JButton	getBtnBack(String text)	Obtiene una referencia al botón de dar un paso atrás
JButton	getBtnCancel(String text)	Obtiene una referencia al botón de cancelar
JButton	getBtnFinish(String text)	Obtiene una referencia al botón de finalizar
JButton	getBtnNext(String text)	Obtiene una referencia al botón de dar un paso adelante
Step	getCurrentStep()	Obtiene el paso actual del asistente
Step[]	getSteps()	Obtiene un array con los pasos del asistente
void	nextStep()	Muestra el panel del siguiente paso del asistente
void	removeWizardListener(WizardListener listener)	Elimina un listener de eventos del wizard

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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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 Details

Wizard

public Wizard(String backText,
 String nextText,
 String finishText,
 String cancelText)

This is the default constructor

Method Details

addWizardListener

public void addWizardListener(WizardListener listener)

Añade un lístener de eventos del wizard

Parameters:

listener -

removeWizardListener

public void removeWizardListener(WizardListener listener)

Elimina un listener de eventos del wizard

Parameters:

listener -

addStep

public void addStep(Step s)

Añade un paso al asistente. Inicializa el paso

Parameters:

s - Paso a añadir

Throws:

RuntimeException - DOCUMENT ME!

enableNext

public void enableNext(boolean enabled)

Activa el paso al siguiente paso del asistente

Specified by:

enableNext in interface WizardControl

Parameters:

enabled - si se habilita o no

enableBack

public void enableBack(boolean enabled)

Activa el paso al paso anterior del asistente

Specified by:

enableBack in interface WizardControl

Parameters:

enabled - si se habilita o no

getBtnBack

public JButton getBtnBack(String text)

Obtiene una referencia al botón de dar un paso atrás

Parameters:

text -

Returns:

javax.swing.JButton

getBtnNext

public JButton getBtnNext(String text)

Obtiene una referencia al botón de dar un paso adelante

Parameters:

text -

Returns:

javax.swing.JButton

getBtnFinish

public JButton getBtnFinish(String text)

Obtiene una referencia al botón de finalizar

Parameters:

finishText -

Returns:

javax.swing.JButton

getBtnCancel

public JButton getBtnCancel(String text)

Obtiene una referencia al botón de cancelar

Parameters:

cancelText -

Returns:

javax.swing.JButton

nextStep

public void nextStep()

Muestra el panel del siguiente paso del asistente

Specified by:

nextStep in interface WizardControl

backStep

public void backStep()

Muestra el panel del paso anterior del asistente

Specified by:

backStep in interface WizardControl

cancel

public void cancel()

Se cancela el asistente. Esta operación no tiene ningún efecto, salvo que se disparará el evento de cancelado. El resultado de esto dependerá de las implementaciones que haya escuchando el evento. Generalmente deberá haber un objeto que al escuchar este evento cerrará el asistente.

Specified by:

cancel in interface WizardControl

finish

public void finish()

Se finaliza el asistente. Esta operación no tiene ningún efecto, salvo que se disparará el evento de finalización. El resultado de esto dependerá de las implementaciones que haya escuchando el evento. Generalmente deberá haber un objeto que al escuchar este evento cerrará el asistente.

Specified by:

finish in interface WizardControl

getSteps

public Step[] getSteps()

Obtiene un array con los pasos del asistente

Returns:

array de pasos

getCurrentStep

public Step getCurrentStep()

Obtiene el paso actual del asistente

Specified by:

getCurrentStep in interface WizardControl

Returns:

Paso actual del asistente