com.jidesoft.wizard
Class DefaultWizardPage

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.jidesoft.dialog.AbstractPage
                      com.jidesoft.dialog.AbstractDialogPage
                          com.jidesoft.wizard.AbstractWizardPage
                              com.jidesoft.wizard.DefaultWizardPage

All Implemented Interfaces:

Laziness, ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

GraphicWizardPage

public class DefaultWizardPage
extends AbstractWizardPage

DefaultWizardPage extends AbstractWizardPage to provide a way to create the content easily.

You certainly can create the whatever wizard content. However most components in wizard content are laid out vertically and have a fixed gap in between. All you need to do is to override initConentPane() and call a bunch of add methods.

• public void addText(String text): add a multiple line text
• public void addText(String text, Font font): add a multiple line text with specified font
• public void addTitle(String text): add a multiple line title (Wizard 97 Standard only)
• public void addWarning(String text): add a multiple line warning text. It will show a warning icon before the text
• public void addInfo(String text): add a multiple line important text but not yet warning. It will show an info icon before the text
• public void addIconText(Icon icon, String text): add a multiple line text with any icon
• public void addComponent(JComponent component): add any component
• public void addSpace(): add space. All components added after addSpace will align to bottom.

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 com.jidesoft.wizard.AbstractWizardPage

_wizardContent, LEFTPANE_CUSTOM, LEFTPANE_EMPTY, LEFTPANE_GRAPHIC, LEFTPANE_HELP, LEFTPANE_NONE, LEFTPANE_STEPS

Fields inherited from class com.jidesoft.dialog.AbstractDialogPage

_buttonEvent, _description, _icon, _pageEnabled, _parentPage, _title, DESCRIPTION_PROPERTY, ICON_PROPERTY, PROPERTY_PAGE_ENABLED, TITLE_PROPERTY

Fields inherited from class com.jidesoft.dialog.AbstractPage

_pageEvent, INVOKE_ON_ALL, INVOKE_ON_NONE, INVOKE_ON_PAINT, INVOKE_ON_REPAINT, INVOKE_ON_UPDATE, INVOKE_ON_VALIDATE

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

DefaultWizardPage(String title)
Creates a DefaultWizardPage with title.

DefaultWizardPage(String title, Icon icon)
Creates a DefaultWizardPage with title and icon.

DefaultWizardPage(String title, String description)
Creates a DefaultWizardPage with title and description.

DefaultWizardPage(String title, String description, Icon icon)
Creates a DefaultWizardPage with title, description and icon.

Method Summary

void	addComponent(JComponent component) Adds any component.
void	addComponent(JComponent component, boolean fill) Adds any component.
void	addIconText(Icon icon, String text) Adds a multiple line text with any icon.
void	addInfo(String text) Adds a multiple line important text.
void	addSpace() Adds space.
void	addText(String text) Adds a multiple line text.
void	addText(String text, Font font) Adds a multiple line text with specified font.
void	addTitle(String text) Adds a multiple line title (Wizard 97 Standard only).
void	addWarning(String text) Adds a multiple line warning text.
protected JComponent	createDefaultContentPane() Creates the content pane by add those pre-added components into a JPanel with JideBoxLayout.
JComponent	createWizardContent() Subclass should implement this method to creates content of a wizard page.
Border	getContentBorder() Gets the content border.
protected void	initContentPane() Subclasses should override this method to add components to wizard page.
void	reset() Resets the page which will result all child components being removed and the method AbstractPage.initialize() being invoked again.
void	setContentBorder(Border contentBorder) Sets the content border.
void	setupWizardButtons() Empty implementation.

Methods inherited from class com.jidesoft.wizard.AbstractWizardPage

getContentThickBorder, getContentThinBorder, getCustomLeftPane, getGraphic, getHelpText, getLeftPaneItems, getOwner, getSelectedStepIndex, getSteps, getWizardContent, lazyInitialize, setHelpText, setLeftPaneItems, showBannerPane, updateHeaderPanel

Methods inherited from class com.jidesoft.dialog.AbstractDialogPage

addButtonListener, fireButtonEvent, fireButtonEvent, fireButtonEvent, focusDefaultFocusComponent, getButtonListeners, getDefaultFocusComponent, getDescription, getFullTitle, getIcon, getParentPage, getTitle, isPageEnabled, removeButtonListener, setDefaultFocusComponent, setDescription, setIcon, setPageEnabled, setParentPage, setTitle

Methods inherited from class com.jidesoft.dialog.AbstractPage

addPageListener, allowClosing, firePageEvent, firePageEvent, getInvokeCondition, getPageListeners, initialize, invalidate, paint, paintAll, paintComponents, removePageListener, repaint, repaint, repaint, repaint, revalidate, setAllowClosing, setInvokeCondition, update

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, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, 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

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, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, 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, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, 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

DefaultWizardPage

public DefaultWizardPage(String title)

Creates a DefaultWizardPage with title.

Parameters:

title -

DefaultWizardPage

public DefaultWizardPage(String title,
                         String description)

Creates a DefaultWizardPage with title and description.

Parameters:

title -

description -

DefaultWizardPage

public DefaultWizardPage(String title,
                         Icon icon)

Creates a DefaultWizardPage with title and icon.

Parameters:

title -

icon -

DefaultWizardPage

public DefaultWizardPage(String title,
                         String description,
                         Icon icon)

Creates a DefaultWizardPage with title, description and icon.

Parameters:

title -

description -

icon -

Method Detail

createDefaultContentPane

protected JComponent createDefaultContentPane()

Creates the content pane by add those pre-added components into a JPanel with JideBoxLayout.

Returns:

the content pane.

addText

public void addText(String text)

Adds a multiple line text.

Parameters:

text -

addText

public void addText(String text,
                    Font font)

Adds a multiple line text with specified font.

Parameters:

text -

font -

addTitle

public void addTitle(String text)

Adds a multiple line title (Wizard 97 Standard only).

Parameters:

text -

addWarning

public void addWarning(String text)

Adds a multiple line warning text. It will show a warning icon before the text. It is using IconMultilinePanel. You can set your own icon by creating your own IconMultilinePanel.

Parameters:

text -

addInfo

public void addInfo(String text)

Adds a multiple line important text. It will show a warning icon before the text. It is using IconMultilinePanel. You can set your own icon by creating your own IconMultilinePanel.

Parameters:

text -

addIconText

public void addIconText(Icon icon,
                        String text)

Adds a multiple line text with any icon.

Parameters:

icon -

text -

addComponent

public void addComponent(JComponent component)

Adds any component.

Parameters:

component -

reset

public void reset()

Description copied from class: AbstractPage

Resets the page which will result all child components being removed and the method AbstractPage.initialize() being invoked again.

Overrides:

reset in class AbstractPage

addComponent

public void addComponent(JComponent component,
                         boolean fill)

Adds any component.

Parameters:

component -

fill - true if the component should fill the whatever space left. Only one component can be added as fill. If several component are added as fill, the last one takes priority.

addSpace

public void addSpace()

Adds space. All components added before space will align to top and after space will align to bottom.

setupWizardButtons

public void setupWizardButtons()

Empty implementation.

Specified by:

setupWizardButtons in class AbstractWizardPage

initContentPane

protected void initContentPane()

Subclasses should override this method to add components to wizard page.

createWizardContent

public JComponent createWizardContent()

Description copied from class: AbstractWizardPage

Subclass should implement this method to creates content of a wizard page.

Specified by:

createWizardContent in class AbstractWizardPage

Returns:

wizard content component

getContentBorder

public Border getContentBorder()

Gets the content border.

By default it will use getContentThinBorder() if user didn't set it.

Returns:

the content border. It will return getContentThinBorder() if user didn't set it.

setContentBorder

public void setContentBorder(Border contentBorder)

Sets the content border.

Parameters:

contentBorder -