Class AbstractSetupPanel

  • All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.lang.Comparable<AbstractSetupPanel>, javax.accessibility.Accessible
    Direct Known Subclasses:
    SetupPanel, SimpleSetupPanel

    public abstract class AbstractSetupPanel
    extends javax.swing.JPanel
    implements java.lang.Comparable<AbstractSetupPanel>
    Ancestor for setup panels for experiments.
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Nested Class Summary

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

        javax.swing.JComponent.AccessibleJComponent
      • Nested classes/interfaces inherited from class java.awt.Component

        java.awt.Component.BaselineResizeBehavior
    • Field Summary

      • Fields inherited from class javax.swing.JComponent

        TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
      • 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
    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract void addPropertyChangeListener​(java.beans.PropertyChangeListener l)
      Adds a PropertyChangeListener who will be notified of value changes.
      void cleanUpAfterSwitch()
      Hook method for cleaning up the interface after a switch.
      int compareTo​(AbstractSetupPanel o)
      Uses the name for comparison.
      abstract Experiment getExperiment()
      Gets the currently configured experiment.
      abstract java.lang.String getName()
      Returns the name of the panel.
      static AbstractSetupPanel[] getPanels()
      Returns a list of all available setup panels.
      abstract void removePropertyChangeListener​(java.beans.PropertyChangeListener l)
      Removes a PropertyChangeListener.
      abstract boolean setExperiment​(Experiment exp)
      Sets the experiment to configure.
      abstract void setModePanel​(SetupModePanel modePanel)
      Sets the panel used to switch between simple and advanced modes.
      abstract void terminate()
      Terminates this panel.
      java.lang.String toString()
      Just returns the name of the panel.
      • Methods inherited from class javax.swing.JPanel

        getAccessibleContext, getUI, getUIClassID, setUI, updateUI
      • Methods inherited from class javax.swing.JComponent

        addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
      • Methods inherited from class java.awt.Container

        add, add, add, add, add, addContainerListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate
      • Methods inherited from class java.awt.Component

        action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • AbstractSetupPanel

        public AbstractSetupPanel()
    • Method Detail

      • getName

        public abstract java.lang.String getName()
        Returns the name of the panel.
        Overrides:
        getName in class java.awt.Component
        Returns:
        the name
      • setModePanel

        public abstract void setModePanel​(SetupModePanel modePanel)
        Sets the panel used to switch between simple and advanced modes.
        Parameters:
        modePanel - the panel
      • setExperiment

        public abstract boolean setExperiment​(Experiment exp)
        Sets the experiment to configure.
        Parameters:
        exp - a value of type 'Experiment'
        Returns:
        true if experiment could be configured, false otherwise
      • getExperiment

        public abstract Experiment getExperiment()
        Gets the currently configured experiment.
        Returns:
        the currently configured experiment.
      • cleanUpAfterSwitch

        public void cleanUpAfterSwitch()
        Hook method for cleaning up the interface after a switch.
        Default implementation does nothing.
      • addPropertyChangeListener

        public abstract void addPropertyChangeListener​(java.beans.PropertyChangeListener l)
        Adds a PropertyChangeListener who will be notified of value changes.
        Overrides:
        addPropertyChangeListener in class java.awt.Container
        Parameters:
        l - a value of type 'PropertyChangeListener'
      • removePropertyChangeListener

        public abstract void removePropertyChangeListener​(java.beans.PropertyChangeListener l)
        Removes a PropertyChangeListener.
        Overrides:
        removePropertyChangeListener in class java.awt.Component
        Parameters:
        l - a value of type 'PropertyChangeListener'
      • compareTo

        public int compareTo​(AbstractSetupPanel o)
        Uses the name for comparison.
        Specified by:
        compareTo in interface java.lang.Comparable<AbstractSetupPanel>
        Parameters:
        o - the other panel
        Returns:
        <0 , 0, >0 if name is less than, equal or greater than this one
        See Also:
        getName()
      • toString

        public java.lang.String toString()
        Just returns the name of the panel.
        Overrides:
        toString in class java.awt.Component
        Returns:
        the name
      • getPanels

        public static AbstractSetupPanel[] getPanels()
        Returns a list of all available setup panels.
        Returns:
        the available panels
      • terminate

        public abstract void terminate()
        Terminates this panel. To be implemented by actual concrete classes.