Save This Page
Home » jcommon-1.0.13 » org.jfree.ui » [javadoc | source]
org.jfree.ui
public class: WizardDialog [javadoc | source]
java.lang.Object
   java.awt.Component
      java.awt.Container
         java.awt.Window
            java.awt.Dialog
               javax.swing.JDialog
                  org.jfree.ui.WizardDialog

All Implemented Interfaces:
    ActionListener, Accessible, TransferHandler$HasGetTransferHandler, RootPaneContainer, WindowConstants, MenuContainer, ImageObserver, Serializable

A dialog that presents the user with a sequence of steps for completing a task. The dialog contains "Next" and "Previous" buttons, allowing the user to navigate through the task.

When the user backs up by one or more steps, the dialog keeps the completed steps so that they can be reused if the user doesn't change anything - this handles the cases where the user backs up a few steps just to review what has been completed.

But if the user changes some options in an earlier step, then the dialog may have to discard the later steps and have them repeated.

THIS CLASS IS NOT WORKING CORRECTLY YET.

Fields inherited from java.awt.Dialog:
DEFAULT_MODALITY_TYPE
Fields inherited from java.awt.Component:
TOP_ALIGNMENT,  CENTER_ALIGNMENT,  BOTTOM_ALIGNMENT,  LEFT_ALIGNMENT,  RIGHT_ALIGNMENT
Constructor:
 public WizardDialog(JDialog owner,
    boolean modal,
    String title,
    WizardPanel firstPanel) 
    Standard constructor - builds and returns a new WizardDialog.
    Parameters:
    owner - the owner.
    modal - modal?
    title - the title.
    firstPanel - the first panel.
 public WizardDialog(JFrame owner,
    boolean modal,
    String title,
    WizardPanel firstPanel) 
    Standard constructor - builds a new WizardDialog owned by the specified JFrame.
    Parameters:
    owner - the owner.
    modal - modal?
    title - the title.
    firstPanel - the first panel.
Method from org.jfree.ui.WizardDialog Summary:
actionPerformed,   canDoNextPanel,   canDoPreviousPanel,   canFinish,   createContent,   finish,   getResult,   getStepCount,   getWizardPanel,   isCancelled,   next,   previous
Methods from javax.swing.JDialog:
getAccessibleContext,   getContentPane,   getDefaultCloseOperation,   getGlassPane,   getGraphics,   getJMenuBar,   getLayeredPane,   getRootPane,   getTransferHandler,   isDefaultLookAndFeelDecorated,   remove,   repaint,   setContentPane,   setDefaultCloseOperation,   setDefaultLookAndFeelDecorated,   setGlassPane,   setJMenuBar,   setLayeredPane,   setLayout,   setTransferHandler,   update
Methods from java.awt.Dialog:
addNotify,   getAccessibleContext,   getModalityType,   getTitle,   hide,   isModal,   isResizable,   isUndecorated,   setModal,   setModalityType,   setResizable,   setTitle,   setUndecorated,   setVisible,   show,   toBack
Methods from java.awt.Window:
addNotify,   addPropertyChangeListener,   addPropertyChangeListener,   addWindowFocusListener,   addWindowListener,   addWindowStateListener,   applyResourceBundle,   applyResourceBundle,   createBufferStrategy,   createBufferStrategy,   dispose,   getAccessibleContext,   getBufferStrategy,   getFocusCycleRootAncestor,   getFocusOwner,   getFocusTraversalKeys,   getFocusableWindowState,   getGraphicsConfiguration,   getIconImages,   getInputContext,   getListeners,   getLocale,   getModalExclusionType,   getMostRecentFocusOwner,   getOwnedWindows,   getOwner,   getOwnerlessWindows,   getToolkit,   getWarningString,   getWindowFocusListeners,   getWindowListeners,   getWindowStateListeners,   getWindows,   hide,   isActive,   isAlwaysOnTop,   isAlwaysOnTopSupported,   isFocusCycleRoot,   isFocusableWindow,   isFocused,   isLocationByPlatform,   isShowing,   pack,   postEvent,   removeNotify,   removeWindowFocusListener,   removeWindowListener,   removeWindowStateListener,   reshape,   setAlwaysOnTop,   setBounds,   setBounds,   setCursor,   setFocusCycleRoot,   setFocusableWindowState,   setIconImage,   setIconImages,   setLocationByPlatform,   setLocationRelativeTo,   setMinimumSize,   setModalExclusionType,   setSize,   setSize,   setVisible,   show,   toBack,   toFront
Methods from java.awt.Container:
add,   add,   add,   add,   add,   addContainerListener,   addNotify,   addPropertyChangeListener,   addPropertyChangeListener,   applyComponentOrientation,   areFocusTraversalKeysSet,   countComponents,   deliverEvent,   doLayout,   findComponentAt,   findComponentAt,   getAlignmentX,   getAlignmentY,   getComponent,   getComponentAt,   getComponentAt,   getComponentCount,   getComponentZOrder,   getComponents,   getContainerListeners,   getFocusTraversalKeys,   getFocusTraversalPolicy,   getInsets,   getLayout,   getListeners,   getMaximumSize,   getMinimumSize,   getMousePosition,   getPreferredSize,   insets,   invalidate,   isAncestorOf,   isFocusCycleRoot,   isFocusCycleRoot,   isFocusTraversalPolicyProvider,   isFocusTraversalPolicySet,   layout,   list,   list,   locate,   minimumSize,   paint,   paintComponents,   preferredSize,   print,   printComponents,   remove,   remove,   removeAll,   removeContainerListener,   removeNotify,   setComponentZOrder,   setFocusCycleRoot,   setFocusTraversalKeys,   setFocusTraversalPolicy,   setFocusTraversalPolicyProvider,   setFont,   setLayout,   transferFocusBackward,   transferFocusDownCycle,   update,   validate
Methods from java.awt.Component:
action,   add,   addComponentListener,   addFocusListener,   addHierarchyBoundsListener,   addHierarchyListener,   addInputMethodListener,   addKeyListener,   addMouseListener,   addMouseMotionListener,   addMouseWheelListener,   addNotify,   addPropertyChangeListener,   addPropertyChangeListener,   applyComponentOrientation,   areFocusTraversalKeysSet,   bounds,   checkImage,   checkImage,   contains,   contains,   createImage,   createImage,   createVolatileImage,   createVolatileImage,   deliverEvent,   disable,   dispatchEvent,   doLayout,   enable,   enable,   enableInputMethods,   firePropertyChange,   firePropertyChange,   firePropertyChange,   firePropertyChange,   firePropertyChange,   firePropertyChange,   getAccessibleContext,   getAlignmentX,   getAlignmentY,   getBackground,   getBaseline,   getBaselineResizeBehavior,   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,   getMousePosition,   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,   isFocusCycleRoot,   isFocusOwner,   isFocusTraversable,   isFocusable,   isFontSet,   isForegroundSet,   isLightweight,   isMaximumSizeSet,   isMinimumSizeSet,   isOpaque,   isPreferredSizeSet,   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,   postEvent,   preferredSize,   prepareImage,   prepareImage,   print,   printAll,   remove,   removeComponentListener,   removeFocusListener,   removeHierarchyBoundsListener,   removeHierarchyListener,   removeInputMethodListener,   removeKeyListener,   removeMouseListener,   removeMouseMotionListener,   removeMouseWheelListener,   removeNotify,   removePropertyChangeListener,   removePropertyChangeListener,   repaint,   repaint,   repaint,   repaint,   requestFocus,   requestFocusInWindow,   reshape,   resize,   resize,   setBackground,   setBounds,   setBounds,   setComponentOrientation,   setCursor,   setDropTarget,   setEnabled,   setFocusTraversalKeys,   setFocusTraversalKeysEnabled,   setFocusable,   setFont,   setForeground,   setIgnoreRepaint,   setLocale,   setLocation,   setLocation,   setMaximumSize,   setMinimumSize,   setName,   setPreferredSize,   setSize,   setSize,   setVisible,   show,   show,   size,   toString,   transferFocus,   transferFocusBackward,   transferFocusUpCycle,   update,   validate
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.jfree.ui.WizardDialog Detail:
 public  void actionPerformed(ActionEvent event) 
    Handles events.
 public boolean canDoNextPanel() 
    Returns true if there is a 'next' panel, and false otherwise.
 public boolean canDoPreviousPanel() 
    Returns true if it is possible to back up to the previous panel, and false otherwise.
 public boolean canFinish() 
    Returns true if it is possible to finish the sequence at this point (possibly with defaults for the remaining entries).
 public JPanel createContent() 
    Creates a panel containing the user interface for the dialog.
 public  void finish() 
    Finishes the wizard.
 public Object getResult() 
    Returns the result of the wizard sequence.
 public int getStepCount() 
    Returns the total number of steps in the wizard sequence, if this number is known. Otherwise this method returns zero. Subclasses should override this method unless the number of steps is not known.
 public WizardPanel getWizardPanel(int step) 
    Returns the panel for the specified step (steps are numbered from zero).
 public boolean isCancelled() 
    Checks, whether the user cancelled the dialog.
 public  void next() 
    Displays the next step in the wizard sequence.
 public  void previous() 
    Handles a click on the "previous" button, by displaying the previous panel in the sequence.