Package org.cesilko.rachota.gui

Class GenericWizard

  • All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.PropertyChangeListener, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants
    Direct Known Subclasses:
    ReportWizard
    public class GenericWizard
extends javax.swing.JDialog
implements java.beans.PropertyChangeListener
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class javax.swing.JDialog

        javax.swing.JDialog.AccessibleJDialog

      • Nested classes/interfaces inherited from class java.awt.Dialog

        java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType

      • Nested classes/interfaces inherited from class java.awt.Window

        java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

      • Nested classes/interfaces inherited from class java.awt.Container

        java.awt.Container.AccessibleAWTContainer

      • Nested classes/interfaces inherited from class java.awt.Component

        java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private javax.swing.JButton btCancel  
      private javax.swing.JButton btFinish  
      private javax.swing.JButton btNext  
      private javax.swing.JButton btPrevious  
      private javax.swing.JLabel lbLogo  
      private javax.swing.JLabel lbPreview  
      private javax.swing.JLabel lbStatus  
      private javax.swing.JPanel pnButtons  
      private javax.swing.JPanel pnOverview  
      private javax.swing.JPanel pnStep  
      private javax.swing.JPanel pnSteps  
      private static java.util.HashMap properties
      Map with wizard properties.
      private int selectedStep
      Index of currently selected step.
      private javax.swing.JSeparator spSeparator  
      private java.util.Vector steps
      Array of wizard steps.

      • Fields inherited from class javax.swing.JDialog

        accessibleContext, rootPane, rootPaneCheckingEnabled

      • Fields inherited from class java.awt.Dialog

        DEFAULT_MODALITY_TYPE

      • 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

      • Fields inherited from interface javax.swing.WindowConstants

        DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

    • Constructor Summary

      Constructors 
      Constructor Description
      GenericWizard​(java.lang.String wizardTitle)
      Creates new form GenericWizard

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addWizardStep​(WizardStep wizardStep)
      Adds new wizard step to this wizard.
      private void btCancelActionPerformed​(java.awt.event.ActionEvent evt)
      Method called when user pushed Cancel button.
      private void btFinishActionPerformed​(java.awt.event.ActionEvent evt)
      Method called when user pushed Finish button.
      private void btNextActionPerformed​(java.awt.event.ActionEvent evt)
      Method called when user pushed Next button.
      private void btPreviousActionPerformed​(java.awt.event.ActionEvent evt)
      Method called when user pushed Previous button.
      protected void cancelWizard()
      Acts like a Cancel button is pressed.
      void checkButtons()
      Method called when something changed and buttons should verify their state.
      protected void finishWizard()
      Acts like a Finish button is pressed.
      java.awt.Font getFont()
      Returns font that should be used for all widgets in this component based on the language preferences specified by user.
      static java.lang.Object getWizardProperty​(java.lang.String propertyName)
      Returns property of wizard identified by its name.
      protected void goNextStep()
      Acts like a Next button is pressed.
      private void initComponents()
      This method is called from within the constructor to initialize the form.
      void propertyChange​(java.beans.PropertyChangeEvent evt)
      Method called when property of some wizard step changed.
      private void selectStep​(int index)
      Method called when new wizard step is selected.
      void setPreview​(javax.swing.ImageIcon preview)
      Sets preview of wizard result.
      void setStatus​(java.lang.String status)
      Sets new status text.
      static void setWizardProperty​(java.lang.String propertyName, java.lang.Object property)
      Sets given wizard property.

      • Methods inherited from class javax.swing.JDialog

        addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

      • Methods inherited from class java.awt.Dialog

        addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBack

      • Methods inherited from class java.awt.Window

        addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront

      • Methods inherited from class java.awt.Container

        add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • steps

        private java.util.Vector steps
        Array of wizard steps.

      • selectedStep

        private int selectedStep
        Index of currently selected step.

      • properties

        private static java.util.HashMap properties
        Map with wizard properties.

      • btCancel

        private javax.swing.JButton btCancel

      • btFinish

        private javax.swing.JButton btFinish

      • btNext

        private javax.swing.JButton btNext

      • btPrevious

        private javax.swing.JButton btPrevious

      • lbLogo

        private javax.swing.JLabel lbLogo

      • lbPreview

        private javax.swing.JLabel lbPreview

      • lbStatus

        private javax.swing.JLabel lbStatus

      • pnButtons

        private javax.swing.JPanel pnButtons

      • pnOverview

        private javax.swing.JPanel pnOverview

      • pnStep

        private javax.swing.JPanel pnStep

      • pnSteps

        private javax.swing.JPanel pnSteps

      • spSeparator

        private javax.swing.JSeparator spSeparator

    • Constructor Detail

      • GenericWizard

        public GenericWizard​(java.lang.String wizardTitle)
        Creates new form GenericWizard

    • Method Detail

      • addWizardStep

        public void addWizardStep​(WizardStep wizardStep)
        Adds new wizard step to this wizard.
        Parameters:
        wizardStep - A wizard step to be added to this wizard.

      • getFont

        public java.awt.Font getFont()
        Returns font that should be used for all widgets in this component based on the language preferences specified by user.
        Specified by:
        getFont in interface java.awt.MenuContainer
        Overrides:
        getFont in class java.awt.Component
        Returns:
        Font to be used in this component.

      • initComponents

        private void initComponents()
        This method is called from within the constructor to initialize the form. WARNING: Do NOT modify this code. The content of this method is always regenerated by the Form Editor.

      • btCancelActionPerformed

        private void btCancelActionPerformed​(java.awt.event.ActionEvent evt)
        Method called when user pushed Cancel button.
        Parameters:
        evt - Event that generated this call.

      • btFinishActionPerformed

        private void btFinishActionPerformed​(java.awt.event.ActionEvent evt)
        Method called when user pushed Finish button.
        Parameters:
        evt - Event that generated this call.

      • btNextActionPerformed

        private void btNextActionPerformed​(java.awt.event.ActionEvent evt)
        Method called when user pushed Next button.
        Parameters:
        evt - Event that generated this call.

      • btPreviousActionPerformed

        private void btPreviousActionPerformed​(java.awt.event.ActionEvent evt)
        Method called when user pushed Previous button.
        Parameters:
        evt - Event that generated this call.

      • selectStep

        private void selectStep​(int index)
        Method called when new wizard step is selected.
        Parameters:
        index - Number of step to be displayed.

      • checkButtons

        public void checkButtons()
        Method called when something changed and buttons should verify their state. Most probably Next button should be enabled or disabled.

      • setPreview

        public void setPreview​(javax.swing.ImageIcon preview)
        Sets preview of wizard result.
        Parameters:
        preview - Image to be set as preview.

      • setWizardProperty

        public static void setWizardProperty​(java.lang.String propertyName,
                                     java.lang.Object property)
        Sets given wizard property.
        Parameters:
        propertyName - Name of property to be set.
        property - New value of given property.

      • getWizardProperty

        public static java.lang.Object getWizardProperty​(java.lang.String propertyName)
        Returns property of wizard identified by its name.
        Parameters:
        propertyName - Name of property to be returned.
        Returns:
        Object representing value of given property.

      • propertyChange

        public void propertyChange​(java.beans.PropertyChangeEvent evt)
        Method called when property of some wizard step changed.
        Specified by:
        propertyChange in interface java.beans.PropertyChangeListener
        Parameters:
        evt - Event that generated this call.

      • setStatus

        public void setStatus​(java.lang.String status)
        Sets new status text.
        Parameters:
        status - New status text.

      • goNextStep

        protected void goNextStep()
        Acts like a Next button is pressed.

      • cancelWizard

        protected void cancelWizard()
        Acts like a Cancel button is pressed.

      • finishWizard

        protected void finishWizard()
        Acts like a Finish button is pressed.