com.klg.jclass.swing
Class JCSplitWizard

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--com.klg.jclass.swing.BaseWizard
                                |
                                +--com.klg.jclass.swing.JCSplitWizard

All Implemented Interfaces:

Accessible, ImageObserver, MenuContainer, Serializable

public class JCSplitWizard

extends BaseWizard

This class creates a wizard with two panes, and a bottom button panel. The left panel can optionally contain an automatically generated Steps list or, like the right panel, any component of the developer's choosing.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

protected JPanel	rightPanel The right panel which holds developer content
protected com.klg.jclass.swing.SplitWizardPage	splitWizardPage The SplitWizardPage that fills this panel

Fields inherited from class com.klg.jclass.swing.BaseWizard

cancelListener, cardLayout, cardOwner, finishListener, helpListener, listeners, nextListener, previousListener

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

JCSplitWizard()
Default constructor which creates a SplitWizard, with standard buttons, and no stepslist.

JCSplitWizard(int buttons, String stepsTitle)
Constructor needs to know which buttons to display, and the progress list title.

Method Summary

void	addPage(Component page, String title) Adds a page to the rightPanel.
boolean	cancel() Invokes the registered "cancel" action.
boolean	finish() Invokes the registered "finish" action
void	first() Moves to the first page in the Wizard.
JButton	getCancelButton()
Component	getCurrentPage() Retireves the current visible page.
JButton	getFinishButton()
JButton	getHelpButton()
JPanel	getLeftPanel()
JButton	getNextButton()
JButton	getPreviousButton()
void	help() Invokes the registered "help" action.
boolean	next() Advances to the next page.
boolean	previous() Moves to the previous page.
protected void	updatePage() updates splicWizard page items like current list item, if any and enabling/disabling next and previous buttons depending upn which page is visible.

Methods inherited from class com.klg.jclass.swing.BaseWizard

addWizardListener, getAbout, isLastPage, last, removeWizardListener, setAbout, show

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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

Field Detail

splitWizardPage

protected com.klg.jclass.swing.SplitWizardPage splitWizardPage

The SplitWizardPage that fills this panel

rightPanel

protected JPanel rightPanel

The right panel which holds developer content

Constructor Detail

JCSplitWizard

public JCSplitWizard()

Default constructor which creates a SplitWizard, with standard buttons, and no stepslist.

JCSplitWizard

public JCSplitWizard(int buttons,
                     String stepsTitle)

Constructor needs to know which buttons to display, and the progress list title.

Parameters:

buttons - which buttons to use - integer values from BaseWizardPage

stepsTitle - The title to use for an automatically generated progressList displayed in the left panel. If null, no list is created.

Method Detail

getNextButton

public JButton getNextButton()

getPreviousButton

public JButton getPreviousButton()

getFinishButton

public JButton getFinishButton()

getCancelButton

public JButton getCancelButton()

getHelpButton

public JButton getHelpButton()

getLeftPanel

public JPanel getLeftPanel()

first

public void first()

Moves to the first page in the Wizard.

Overrides:

first in class BaseWizard

See Also:

BaseWizard.last(), BaseWizard.show(java.lang.String)

next

public boolean next()

Advances to the next page.

Specified by:

next in class BaseWizard

Returns:

See Also:

previous(), finish(), cancel()

previous

public boolean previous()

Moves to the previous page.

Specified by:

previous in class BaseWizard

Returns:

whether the move to the previous page was successful.

See Also:

next(), finish(), cancel()

updatePage

protected void updatePage()

updates splicWizard page items like current list item, if any and enabling/disabling next and previous buttons depending upn which page is visible.

cancel

public boolean cancel()

Invokes the registered "cancel" action.

Specified by:

cancel in class BaseWizard

Returns:

whether the cancel succeeded or failed.

See Also:

next(), previous(), finish()

help

public void help()

Invokes the registered "help" action.

Specified by:

help in class BaseWizard

See Also:

next(), previous(), finish(), cancel()

finish

public boolean finish()

Invokes the registered "finish" action

Specified by:

finish in class BaseWizard

Returns:

whether or not the action was successful

See Also:

next(), previous(), cancel()

getCurrentPage

public Component getCurrentPage()

Retireves the current visible page.

Specified by:

getCurrentPage in class BaseWizard

Returns:

current visible page

addPage

public void addPage(Component page,
                    String title)

Adds a page to the rightPanel.

Parameters:

page - Component which will populate the right panel

title - Title for the right panel, which will appear above the right panel, and in the progresslist, if used.