MVT API

mvt.tools
Class ToolPanel

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--mvt.tools.ToolPanel
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable
Direct Known Subclasses:
DecompositionTool, FindRootTool, GraphicsPanel, IntegrationTool, LinearSystemTool, MatrixTool, ODETool, ODEVectorFieldTool, PlotTool, Root1DTool, Root2DTool, Root3DTool, VectorFieldTool

public abstract class ToolPanel
extends javax.swing.JPanel

Any Tabbed Tool will be a subclass of this object, and will add tools that inhert from this class or one of its children. ToolPanel is an abstract class that handles the interaction between the panel and the menu bar, and can be subclassed by any MVT tool object.

Since:
JDK1.2
Author:
Darin Gillis
, for the Mathematical Visualization Project for the Department of Applied Mathematics, University of Colorado at Boulder
See Also:
Serialized Form

Nested Class Summary
 class ToolPanel.CloseListener
          ActionListener for use with the "Close" menu option.
 class ToolPanel.HelpListener
          ActionListener for use with the "Help" menu option.
 class ToolPanel.MenuChangeListener
          The Menu Change Listener - this filps the menu bar along with the tabbing action of tabbed tools.
 class ToolPanel.OptionsListener
          The Options Menu Item listener
 
Nested classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Container
 
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
 
Constructor Summary
ToolPanel(java.lang.String toolTitle)
           
ToolPanel(java.lang.String toolTitle, OptionsPanel optionsPanel)
           
ToolPanel(java.lang.String toolTitle, ToolPanel[] panels)
          Give this consructor an array of ToolPanels, and it will created a TabbedPane to access them all.
 
Method Summary
 void buildMenu(javax.swing.JInternalFrame owner)
          Installs the Close, Help, and OptionsHandler's OptionsHandler only installed if an OptionsPanel is available.
 void errorMessage(java.lang.String str)
          Display and error dialog box with this panel as its parent.
 ToolPanel getActiveToolPanel()
          Get the active ToolPanel, which can be either the current ToolPanel or one of the tools in a JTabbedPane.
 OptionsPanel getOptionsPanel()
          Get the OptionsPanel for this tool, if there is one.
 java.lang.String getTitle()
          Used to get the title of this ToolPanel (specifically used by tools w/ TabbedPanes)
 void pack()
          This function will only work if buildMenu has been called, because that is the place that the owning JInternalFrame has been set.
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ToolPanel

public ToolPanel(java.lang.String toolTitle)

ToolPanel

public ToolPanel(java.lang.String toolTitle,
                 OptionsPanel optionsPanel)

ToolPanel

public ToolPanel(java.lang.String toolTitle,
                 ToolPanel[] panels)
Give this consructor an array of ToolPanels, and it will created a TabbedPane to access them all. The title of each panel will be put on its respective tab.

Method Detail

getActiveToolPanel

public ToolPanel getActiveToolPanel()
Get the active ToolPanel, which can be either the current ToolPanel or one of the tools in a JTabbedPane.


getOptionsPanel

public OptionsPanel getOptionsPanel()
Get the OptionsPanel for this tool, if there is one.


buildMenu

public void buildMenu(javax.swing.JInternalFrame owner)
Installs the Close, Help, and OptionsHandler's OptionsHandler only installed if an OptionsPanel is available.


pack

public void pack()
This function will only work if buildMenu has been called, because that is the place that the owning JInternalFrame has been set.


getTitle

public java.lang.String getTitle()
Used to get the title of this ToolPanel (specifically used by tools w/ TabbedPanes)


errorMessage

public void errorMessage(java.lang.String str)
Display and error dialog box with this panel as its parent.


MVT API

mvt.icons