Oracle JEWT API Reference
Release 4.2.31.0.0
B12199-01

oracle.bali.ewt.wizard
Class WizardFrame

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Frame
                          |
                          +--javax.swing.JFrame
                                |
                                +--oracle.bali.ewt.wizard.WizardFrame
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

public class WizardFrame
extends javax.swing.JFrame

Clients should generally avoid using WizardFrame. WizardFrame is a legacy class and is provided only for backwards compatibility.

The WizardFrame class provides a simple way of running a wizard in a frame until the user either cancels or finishes the wizard. It doesn't handle any of the issues of page navigation and validation; clients should interact directly with the Wizard for these issues. Unlike WizardDialog, there is no trivial way to block until the Wizard has finished. As a result, clients that need to detect when the wizard has finished should either:

WizardFrame is generally intended for clients whose wizard is their entire application; Java Frames have a few desirable characteristics for this use:

The WizardFrame also doesn't reset the currently visible page each time it's run; that is also the client's responsibility.

It is legal to use the same wizard in multiple WizardFrames, but only one of those frames must be running at a time.

See Also:
BaseWizard, Serialized Form

Inner classes inherited from class javax.swing.JFrame
javax.swing.JFrame.AccessibleJFrame

Inner classes inherited from class java.awt.Frame
java.awt.Frame.AccessibleAWTFrame

Inner classes inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow

Inner classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer

Inner classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent

Fields inherited from class javax.swing.JFrame
accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary
WizardFrame()
Creates a WizardFrame.
WizardFrame(BaseWizard wizard)
Creates a WizardFrame.
WizardFrame(BaseWizard wizard, java.lang.String title)
Creates a WizardFrame.

Method Summary
protected void dismissFrame(boolean cancelled)
Hides the frame.
BaseWizard getWizard()
Returns the wizard used by the frame.
boolean isCancelled()
Returns true if the frame was cancelled in its last run.
protected void processWindowEvent(java.awt.event.WindowEvent e)
Processes window events occurring on this window.
void setWizard(BaseWizard wizard)
Sets the wizard used by the frame.
void show()
Runs the wizard in this frame.

Methods inherited from class javax.swing.JFrame
addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isRootPaneCheckingEnabled, paramString, processKeyEvent, remove, setContentPane, setDefaultCloseOperation, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.awt.Frame
addNotify, finalize, getCursorType, getFrames, getIconImage, getMenuBar, getState, getTitle, isResizable, remove, removeNotify, setCursor, setIconImage, setMenuBar, setResizable, setState, setTitle

Methods inherited from class java.awt.Window
addWindowListener, applyResourceBundle, applyResourceBundle, dispose, getFocusOwner, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getOwnedWindows, getOwner, getToolkit, getWarningString, hide, isShowing, pack, postEvent, processEvent, removeWindowListener, setCursor, toBack, toFront

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setFont, validate, validateTree

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputMethodRequests, getLocation, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseMotionEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.awt.MenuContainer
getFont, postEvent

Constructor Detail

WizardFrame

public WizardFrame()
Creates a WizardFrame.

WizardFrame

public WizardFrame(BaseWizard wizard)
Creates a WizardFrame.
Parameters:
wizard - the embedded wizard.

WizardFrame

public WizardFrame(BaseWizard wizard,
                   java.lang.String title)
Creates a WizardFrame.
Parameters:
wizard - the embedded wizard.
title - the window title

Method Detail

getWizard

public BaseWizard getWizard()
Returns the wizard used by the frame.

setWizard

public void setWizard(BaseWizard wizard)
Sets the wizard used by the frame.

isCancelled

public boolean isCancelled()
Returns true if the frame was cancelled in its last run. If the frame is currently visible, always returns false.

show

public void show()
Runs the wizard in this frame. Unlike WizardDialog, immediately returns. The wizard is automatically added and the frame sized, layed out, and centered on screen.
Overrides:
show in class java.awt.Window
Throws:
java.lang.IllegalStateException - if the wizard has a parent already, or the frame is already visible.

dismissFrame

protected void dismissFrame(boolean cancelled)
Hides the frame.
Parameters:
cancelled - true if the cancel button was pressed, false if the finish button was pressed.

processWindowEvent

protected void processWindowEvent(java.awt.event.WindowEvent e)
Processes window events occurring on this window.
Overrides:
processWindowEvent in class javax.swing.JFrame
Parameters:
e - the window event

Oracle JEWT 4.2.31

Copyright © 1998,2004, Oracle. All rights reserved.