jadex.commons.gui

Class JWizard

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

jadex.commons.gui.JWizard

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class JWizard
extends javax.swing.JPanel

GUI class for creating wizard dialogs.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JWizard.ChoiceNode A node for implementing a multiple choice fork.
protected static class	JWizard.WizardNode

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected JBusyRing	busyring The busy ring.
protected javax.swing.JPanel	buttonpanel The current button panel.
static int	CANCEL_ID ID for cancel events.
protected JWizard.WizardNode	current Current frame of the wizard.
static int	FINISH_ID ID for finish events.
protected javax.swing.JPanel	mainpanel
protected javax.swing.JButton	nextbutton The button for the next/finish action, can be disabled.
protected JWizard.WizardNode	start Start frame of the wizard.
protected java.util.Set<java.awt.event.ActionListener>	terminationlisteners Listeners called when wizard terminates.

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 and Description
JWizard() Creates the wizard.

Method Summary

Modifier and Type	Method and Description
void	addTerminationListener(java.awt.event.ActionListener lis) Adds a termination listener.
protected void	back() Shows the next panel.
void	cancel() Cancel the wizard.
protected void	configureButtons() Configures the buttons.
static javax.swing.JFrame	createFrame(java.lang.String title, JWizard wizard) Creates a frame for the wizard that closes on finish.
void	finish() Finish the wizard.
protected void	next() Shows the next panel.
protected void	performOnAllNodes(ICommand<JWizard.WizardNode> command) Recursively runs command all nodes.
protected void	performOnAllNodesRecur(ICommand<JWizard.WizardNode> command, JWizard.WizardNode node, java.util.Set<JWizard.WizardNode> known) Recursively runs command all sub-nodes.
void	removeTerminationListener(java.awt.event.ActionListener lis) Removes a termination listener.
protected void	reset() Resets the wizard.
void	setAllButtonsEnabled(boolean enabled) Sets the enabled state of all buttons (next, back etc.).
void	setEnableNext(boolean enabled) Sets the enabled state of the next/finish button.

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

Field Detail

FINISH_ID

public static final int FINISH_ID

ID for finish events.

See Also:

Constant Field Values

CANCEL_ID

public static final int CANCEL_ID

ID for cancel events.

See Also:

Constant Field Values

start

protected JWizard.WizardNode start

Start frame of the wizard.

current

protected JWizard.WizardNode current

Current frame of the wizard.

mainpanel

protected javax.swing.JPanel mainpanel

buttonpanel

protected javax.swing.JPanel buttonpanel

The current button panel.

nextbutton

protected javax.swing.JButton nextbutton

The button for the next/finish action, can be disabled.

busyring

protected JBusyRing busyring

The busy ring.

terminationlisteners

protected java.util.Set<java.awt.event.ActionListener> terminationlisteners

Listeners called when wizard terminates.

Constructor Detail

JWizard

public JWizard()

Creates the wizard.

Method Detail

setAllButtonsEnabled

public void setAllButtonsEnabled(boolean enabled)

Sets the enabled state of all buttons (next, back etc.).

Parameters:

enabled - True, if enabled

setEnableNext

public void setEnableNext(boolean enabled)

Sets the enabled state of the next/finish button.

Parameters:

enabled - True, if enabled

finish

public void finish()

Finish the wizard.

cancel

public void cancel()

Cancel the wizard.

addTerminationListener

public void addTerminationListener(java.awt.event.ActionListener lis)

Adds a termination listener.

Parameters:

lis - The listener.

removeTerminationListener

public void removeTerminationListener(java.awt.event.ActionListener lis)

Removes a termination listener.

Parameters:

lis - The listener.

next

protected void next()

Shows the next panel.

back

protected void back()

Shows the next panel.

reset

protected void reset()

Resets the wizard.

performOnAllNodes

protected void performOnAllNodes(ICommand<JWizard.WizardNode> command)

Recursively runs command all nodes.

Parameters:

command - The command.

performOnAllNodesRecur

protected void performOnAllNodesRecur(ICommand<JWizard.WizardNode> command,
                                      JWizard.WizardNode node,
                                      java.util.Set<JWizard.WizardNode> known)

Recursively runs command all sub-nodes.

Parameters:

command - The command.

node - The start node.

known - Known nodes to prune loops.

configureButtons

protected void configureButtons()

Configures the buttons.

createFrame

public static final javax.swing.JFrame createFrame(java.lang.String title,
                                                   JWizard wizard)

Creates a frame for the wizard that closes on finish.

Parameters:

title - Title of the frame.

wizard - The wizard.

Returns:

The frame.