|
Oracle JEWT API Reference Release 4.2.24.0.0 B12199-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.awt.Component | +--java.awt.Container | +--java.awt.Window | +--java.awt.Dialog | +--javax.swing.JDialog | +--oracle.bali.ewt.wizard.WizardDialog
The WizardDialog class provides a simple way of running a wizard in a dialog 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.
The WizardDialog 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 WizardDialogs, but only one of those dialogs must be running at a time.
BaseWizard
, Serialized FormInner classes inherited from class javax.swing.JDialog |
javax.swing.JDialog.AccessibleJDialog |
Inner classes inherited from class java.awt.Dialog |
java.awt.Dialog.AccessibleAWTDialog |
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.JDialog |
accessibleContext, rootPane, rootPaneCheckingEnabled |
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 | |
WizardDialog()
Creates a modal WizardDialog without an embedded wizard. |
|
WizardDialog(BaseWizard wizard)
Creates a modal WizardDialog without a specified parent frame. |
|
WizardDialog(BaseWizard wizard,
java.awt.Dialog parent)
Creates a modal WizardDialog. |
|
WizardDialog(BaseWizard wizard,
java.awt.Dialog parent,
boolean modal)
Creates a WizardDialog. |
|
WizardDialog(BaseWizard wizard,
java.awt.Frame parent)
Creates a modal WizardDialog. |
|
WizardDialog(BaseWizard wizard,
java.awt.Frame parent,
boolean modal)
Creates a WizardDialog. |
Method Summary | |
protected void |
dismissDialog(boolean cancelled)
Hides the dialog. |
void |
dispose()
Override to free more memory. |
java.awt.Component |
getCenterOver()
Returns the component over which the wizard will be centered. |
java.util.Locale |
getLocale()
Returns the locale of the wizard. |
java.awt.Dimension |
getPreferredSize()
Return the preferredSize of the wizard. |
WelcomeWizardPage |
getWelcomeWizardPage()
gets the WelcomeWizardPage |
BaseWizard |
getWizard()
Returns the wizard used by the dialog. |
java.lang.String |
getWizardTitle()
Gets the base title for the wizard. |
boolean |
isCancelled()
Returns true if the dialog was cancelled from its last run. |
boolean |
isFinishPageIncluded()
Get if a finish page is included in the set of wizard pages in the wizard. |
boolean |
isWelcomePageIncluded()
Get if a welcome page is included in the set of wizard pages in the wizard. |
protected void |
processComponentEvent(java.awt.event.ComponentEvent e)
Override to not allow resizing smaller than initial size. |
protected void |
processWindowEvent(java.awt.event.WindowEvent e)
Processes window events occurring on this window. |
boolean |
runDialog()
Runs the wizard in this dialog until it is either cancelled or finishes succesfully. |
void |
setCenterOver(java.awt.Component centerOver)
Sets the component over which the wizard will be centered. |
void |
setFinishPageIncluded(boolean finishPage)
Set if a finish page is included in the set of wizard pages in the wizard. |
void |
setLocale(java.util.Locale locale)
Sets the locale of the wizard. |
void |
setWelcomePageIncluded(boolean welcomePage)
Deprecated. use setWelcomeWizardPage() instead of this. |
void |
setWelcomeWizardPage(WelcomeWizardPage welcomePage)
Sets the welcomePage. |
void |
setWizard(BaseWizard wizard)
Sets the wizard used by the dialog. |
void |
setWizardTitle(java.lang.String wizardTitle)
Sets the base title for the wizard. |
Methods inherited from class javax.swing.JDialog |
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isRootPaneCheckingEnabled, paramString, processKeyEvent, remove, setContentPane, setDefaultCloseOperation, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setLocationRelativeTo, setRootPane, setRootPaneCheckingEnabled, update |
Methods inherited from class java.awt.Dialog |
addNotify, getTitle, hide, isModal, isResizable, setModal, setResizable, setTitle, show |
Methods inherited from class java.awt.Window |
addWindowListener, applyResourceBundle, applyResourceBundle, finalize, getFocusOwner, getGraphicsConfiguration, getInputContext, getListeners, getOwnedWindows, getOwner, getToolkit, getWarningString, 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, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, 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, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseMotionEvent, remove, 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, 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 |
Constructor Detail |
public WizardDialog()
public WizardDialog(BaseWizard wizard)
wizard
- the embedded wizard.public WizardDialog(BaseWizard wizard, java.awt.Frame parent)
wizard
- the embedded wizard.parent
- the parent frame.public WizardDialog(BaseWizard wizard, java.awt.Frame parent, boolean modal)
wizard
- the embedded wizard.parent
- the parent frame.modal
- true for modal, false for nonmodalpublic WizardDialog(BaseWizard wizard, java.awt.Dialog parent)
wizard
- the embedded wizard.parent
- the parent dialog.public WizardDialog(BaseWizard wizard, java.awt.Dialog parent, boolean modal)
wizard
- the embedded wizard.parent
- the parent frame.modal
- true for modal, false for nonmodalMethod Detail |
public BaseWizard getWizard()
public void setWizard(BaseWizard wizard)
public void setWizardTitle(java.lang.String wizardTitle)
public java.lang.String getWizardTitle()
public void setWelcomePageIncluded(boolean welcomePage)
public boolean isWelcomePageIncluded()
public void setWelcomeWizardPage(WelcomeWizardPage welcomePage)
welcomePage
- WelcomeWizardPagepublic WelcomeWizardPage getWelcomeWizardPage()
public void setFinishPageIncluded(boolean finishPage)
public boolean isFinishPageIncluded()
public boolean isCancelled()
public java.awt.Component getCenterOver()
public void setCenterOver(java.awt.Component centerOver)
public boolean runDialog()
java.lang.IllegalStateException
- if the wizard has a parent
already, or the dialog is already visible.public void setLocale(java.util.Locale locale)
setLocale
in class java.awt.Component
public java.util.Locale getLocale()
getLocale
in class java.awt.Window
public java.awt.Dimension getPreferredSize()
getPreferredSize
in class java.awt.Container
public void dispose()
dispose
in class java.awt.Dialog
protected void dismissDialog(boolean cancelled)
cancelled
- true if the cancel button was pressed, false
if the finish button was pressed.protected void processComponentEvent(java.awt.event.ComponentEvent e)
processComponentEvent
in class java.awt.Component
protected void processWindowEvent(java.awt.event.WindowEvent e)
processWindowEvent
in class javax.swing.JDialog
e
- the window event
|
Oracle JEWT 4.2.24 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |