WizardDialog Class

com.bea.ide.ui.wizard
WizardDialog Class

public class WizardDialog

    extends EscapeDialog
    implements IWizardContext

The class that instantiates a Wizard object and guides the user through each step.


Hierarchy
Object
  Component
    Container
      Window
        Dialog
          JDialog
            EscapeDialog
              WizardDialog
All Implemented Interfaces

Accessible, ImageObserver, IWizardContext, MenuContainer, RootPaneContainer, Serializable, WindowConstants

Nested Class Summary

 
Nested classes from  javax.swing.JDialog
JDialog.AccessibleJDialog
 
Nested classes from  java.awt.Dialog
Dialog.AccessibleAWTDialog
 
Nested classes from  java.awt.Window
Window.AccessibleAWTWindow
 
Nested classes from  java.awt.Container
Container.AccessibleAWTContainer
 
Nested classes from  java.awt.Component
Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy
 

Field Summary

   
Fields from  javax.swing.JDialog
accessibleContext, rootPane, rootPaneCheckingEnabled
 
Fields from  java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Fields from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
 

Constructor Summary

WizardDialog(IWizard wiz, Frame f)

Construct a new wizard dialog parented to the given frame
WizardDialog(IWizard wiz)

Construct a new wizard dialog parented to the root frame
 

Method Summary

public void
dispose()
public Component
getComponent()
Returns the top level window for this wizard, for use in parenting error messages and sub-dialogs.
protected Action
getEscapeListener()
This returns an action object that is invoked when the escape key is pressed.
public Dimension
getMaximumSize()
public Dimension
getPreferredSize()
public void
resetButtonStates()
This method will cause the WizardDialog to requery the wizard and current step about the enabled state of the buttons in the button bar.
public void
setPreferredSize(Dimension d)
This method allows the size of the wizard dialog to be customized
public void
show()
Display the wizard
 
Methods from  com.bea.ide.util.swing.EscapeDialog
createRootPane, getMinimumSize, setDefaultButton
 
Methods from  javax.swing.JDialog
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update
 
Methods from  java.awt.Dialog
addNotify, dispose, getAccessibleContext, getTitle, hide, isModal, isResizable, isUndecorated, paramString, setModal, setResizable, setTitle, setUndecorated,
 
Methods from  java.awt.Window
addNotify, addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, finalize, getAccessibleContext, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, show, toBack, toFront
 
Methods from  java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMinimumSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, setLayout, transferFocusBackward, transferFocusDownCycle, update, validate, validateTree
 
Methods from  java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, update, validate
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
   
Methods from interface javax.accessibility.Accessible
getAccessibleContext
 
Methods from interface java.awt.image.ImageObserver
imageUpdate
 
Methods from interface com.bea.ide.ui.wizard.IWizardContext
getComponent, resetButtonStates
 
Methods from interface java.awt.MenuContainer
getFont, postEvent, remove
 
Methods from interface javax.swing.RootPaneContainer
getContentPane, getGlassPane, getLayeredPane, getRootPane, setContentPane, setGlassPane, setLayeredPane
 

Constructor Detail

WizardDialog

public WizardDialog(IWizard wiz, 
                    Frame f)
Construct a new wizard dialog parented to the given frame

WizardDialog

public WizardDialog(IWizard wiz)
Construct a new wizard dialog parented to the root frame
 

Method Detail

dispose() Method

public void dispose()
Overrides
EscapeDialog.dispose()

getComponent() Method

public Component getComponent()
Description copied from IWizardContext.getComponent()
Returns the top level window for this wizard, for use in parenting error messages and sub-dialogs.


getEscapeListener() Method

protected Action getEscapeListener()
Description copied from EscapeDialog.getEscapeListener()
This returns an action object that is invoked when the escape key is pressed. The default behavior is to call dispose(). Derived classes may override it to change the behavior.

Overrides
EscapeDialog.getEscapeListener()

getMaximumSize() Method

public Dimension getMaximumSize()
Overrides
Container.getMaximumSize()

getPreferredSize() Method

public Dimension getPreferredSize()
Overrides
Container.getPreferredSize()

resetButtonStates() Method

public void resetButtonStates()
Description copied from IWizardContext.resetButtonStates()
This method will cause the WizardDialog to requery the wizard and current step about the enabled state of the buttons in the button bar. It should be called whenever the information on the current page changes in a way that makes the state of the buttons change.


setPreferredSize(Dimension) Method

public void setPreferredSize(Dimension d)
This method allows the size of the wizard dialog to be customized

Parameters

d
Dimension object specifying the preferred height and width of the dialog

show() Method

public void show()
Display the wizard

Overrides
Dialog.show()