com.jidesoft.wizard
Class JavaStepsPane

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.jidesoft.wizard.LeftPane
                      com.jidesoft.wizard.GraphicLeftPane
                          com.jidesoft.wizard.StepsPane
                              com.jidesoft.wizard.JavaStepsPane

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class JavaStepsPane
extends StepsPane

JavaStepsPane is a pane used by Java L&F wizard standard to display a a list of steps in the left pane.

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

protected JList	_contentList The JList contains the steps.
protected boolean	_contentNumbered
protected JavaWizardHeader	_header
protected boolean	_navigable
protected Color	_selectionBackground
protected Color	_selectionForeground
protected WizardDialogPane	_wizardDialogPane

Fields inherited from class com.jidesoft.wizard.GraphicLeftPane

_image, _imageHeight, _imageWidth

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

JavaStepsPane()
Creates JavaStepsPane.

JavaStepsPane(Image image)

Method Summary

protected String	getResourceString(String key) Gets the localized string from resource bundle.
Color	getSelectionBackground() Gets the selection background in the step list.
Color	getSelectionForeground() Gets the selection foreground in the step list.
JList	getStepsList() Gets the JList that shows the steps.
WizardDialogPane	getWizardDialogPane()
boolean	isNavigable()
void	setNavigable(boolean navigable) Makes the StepsPane navigable.
void	setPageList(List<String> list) Sets the page list.
void	setPageList(PageList list) Sets the page list.
void	setSelectedIndex(int index)
void	setSelectedIndex(int index, boolean fireEvent) Sets the selected page using the index.
void	setSelectedPage(String title)
void	setSelectedPage(String title, boolean fireEvent) Sets the selected page in the list.
void	setSelectionBackground(Color selectionBackground) Sets the selection background.
void	setSelectionForeground(Color selectionForeground) Sets the selection foreground.
void	setWizardDialogPane(WizardDialogPane wizardDialogPane)

Methods inherited from class com.jidesoft.wizard.GraphicLeftPane

getPreferredSize, paintComponent

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, 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, 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

Field Detail

_selectionBackground

protected Color _selectionBackground

_selectionForeground

protected Color _selectionForeground

_contentNumbered

protected boolean _contentNumbered

_navigable

protected boolean _navigable

_wizardDialogPane

protected WizardDialogPane _wizardDialogPane

_contentList

protected JList _contentList

The JList contains the steps.

_header

protected JavaWizardHeader _header

Constructor Detail

JavaStepsPane

public JavaStepsPane()

Creates JavaStepsPane.

JavaStepsPane

public JavaStepsPane(Image image)

Method Detail

setPageList

public void setPageList(PageList list)

Sets the page list.

Specified by:

setPageList in class StepsPane

Parameters:

list - PageList

setPageList

public void setPageList(List<String> list)

Sets the page list.

Specified by:

setPageList in class StepsPane

Parameters:

list - a list of titles

getResourceString

protected String getResourceString(String key)

Gets the localized string from resource bundle. Subclass can override it to provide its own string. Available keys are defined in wizard.properties.

Parameters:

key - the resource key.

Returns:

the localized string.

setSelectedPage

public void setSelectedPage(String title)

Specified by:

setSelectedPage in class StepsPane

setSelectedPage

public void setSelectedPage(String title,
                            boolean fireEvent)

Sets the selected page in the list.

Specified by:

setSelectedPage in class StepsPane

Parameters:

title - the selected page title.

fireEvent - true to call setCurrentPage to set the current page in the wizard. False to select the step in the list only and do not call setCurrentPage.

setSelectedIndex

public void setSelectedIndex(int index)

Specified by:

setSelectedIndex in class StepsPane

setSelectedIndex

public void setSelectedIndex(int index,
                             boolean fireEvent)

Sets the selected page using the index.

Specified by:

setSelectedIndex in class StepsPane

Parameters:

index - the selected page index.

fireEvent - true to call setCurrentPage to set the current page in the wizard. False to select the step in the list only and do not call setCurrentPage.

getSelectionBackground

public Color getSelectionBackground()

Gets the selection background in the step list.

Returns:

the selection background.

setSelectionBackground

public void setSelectionBackground(Color selectionBackground)

Sets the selection background.

Parameters:

selectionBackground - the new selection background when the step in the list is selected.

getSelectionForeground

public Color getSelectionForeground()

Gets the selection foreground in the step list.

Returns:

the selection foreground.

setSelectionForeground

public void setSelectionForeground(Color selectionForeground)

Sets the selection foreground.

Parameters:

selectionForeground - the new selection foreground when the step in the list is selected.

getStepsList

public JList getStepsList()

Gets the JList that shows the steps.

Returns:

the JList that shows the steps.

isNavigable

public boolean isNavigable()

Specified by:

isNavigable in class StepsPane

setNavigable

public void setNavigable(boolean navigable)

Makes the StepsPane navigable.

Specified by:

setNavigable in class StepsPane

Parameters:

navigable - true or false.

getWizardDialogPane

public WizardDialogPane getWizardDialogPane()

Specified by:

getWizardDialogPane in class StepsPane

setWizardDialogPane

public void setWizardDialogPane(WizardDialogPane wizardDialogPane)

Specified by:

setWizardDialogPane in class StepsPane