Package mars.tools

Class AbstractMarsTool

java.lang.Object
java.awt.Component
java.awt.Container
java.awt.Window
java.awt.Frame
javax.swing.JFrame
mars.tools.AbstractMarsTool
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants, Memory.Listener, MarsTool
Direct Known Subclasses:
BHTSimulator, BitmapDisplay, CacheSimulator, DigitalLabSimulator, FloatRepresentation, InstructionCounter, InstructionStatistics, IntroToTools, KeyboardAndDisplaySimulator, MemoryReferenceVisualization, MipsXray, VisualStack
public abstract class AbstractMarsTool extends JFrame implements MarsTool, Memory.Listener
An abstract class that provides generic components to facilitate implementation of a MarsTool and/or stand-alone Mars-based application. Provides default definitions of both the action() method required to implement MarsTool and the go() method conventionally used to launch a Mars-based stand-alone application. It also provides generic definitions for interactively controlling the application. The generic controls for MarsTools are 3 buttons: connect/disconnect to MIPS resource (memory and/or registers), reset, and close (exit). The generic controls for stand-alone Mars apps include: button that triggers a file open dialog, a text field to display status messages, the run-speed slider to control execution rate when running a MIPS program, a button that assembles and runs the current MIPS program, a button to interrupt the running MIPS program, a reset button, and an exit button.
Author:
Pete Sanderson, 14 November 2006
See Also:

  • Field Details

    • dialog

      protected JDialog dialog

  • Constructor Details

    • AbstractMarsTool

      protected AbstractMarsTool(String title)
      Simple constructor
      Parameters:
      title - String containing title bar text

  • Method Details

    • getName

      public abstract String getName()
      Required MarsTool method to return Tool name. Must be defined by subclass.
      Specified by:
      getName in interface MarsTool
      Overrides:
      getName in class Component
      Returns:
      Tool name. MARS will display this in menu item.

    • buildMainDisplayArea

      protected abstract JComponent buildMainDisplayArea()
      Abstract method that must be instantiated by subclass to build the main display area of the GUI. It will be placed in the CENTER area of a BorderLayout. The title is in the NORTH area, and the controls are in the SOUTH area.

    • action

      public void action()
      This is invoked when the user selects this tool from the Tools menu. This default implementation provides generic definitions for interactively controlling the tool. The generic controls for MarsTools are 3 buttons: reset, help, and close.

      This calls 3 methods that can be defined/overriden in the subclass: initializePreGUI() for any special initialization that must be completed before building the user interface (e.g. data structures whose properties determine default GUI settings), initializePostGUI() for any special initialization that cannot be completed until after building the user interface (e.g. data structure whose properties are determined by default GUI settings), and buildMainDisplayArea() to contain application-specific displays of parameters and results.

      Specified by:
      action in interface MarsTool

    • initializePreGUI

      protected void initializePreGUI()
      Method that will be called once just before the GUI is constructed in the go() and action() methods. Use it to initialize any data structures needed for the application whose values will be needed to determine the initial state of GUI components. Does nothing by default.

    • initializePostGUI

      protected void initializePostGUI()
      Method that will be called once just after the GUI is constructed in the go() and action() methods. Use it to initialize data structures needed for the application whose values may depend on the initial state of GUI components. Does nothing by default.

    • reset

      protected void reset()
      Method that will be called each time the default Reset button is clicked. Use it to reset any data structures and/or GUI components. Does nothing by default.

    • buildContentPane

      protected JComponent buildContentPane(JComponent mainDisplayArea, JComponent buttonArea)

    • buildButtonArea

      protected JComponent buildButtonArea()
      The MarsTool default set of controls has one row of 3 buttons. It includes a dual-purpose button to attach or detach simulator to MIPS memory, a button to reset the cache, and one to close the tool.

    • handleClose

      protected void handleClose()
      This method is called when tool/app is exited either through the "Close" button or the window's X button. Override it to perform any special cleaning needed. Does nothing by default.

    • startObserving

      protected void startObserving()
      Register this tool as a listener of memory and/or registers, if applicable. This method is called when the tool is opened by the user. Does nothing by default.
      See Also:

    • stopObserving

      protected void stopObserving()
      Unregister this tool as a listener of memory and/or registers, if applicable. This method is called when the tool is closed by the user. Does nothing by default.
      See Also:

    • getHelpComponent

      protected JComponent getHelpComponent()
      Override this method to provide a JComponent (probably a JButton) of your choice to be placed just left of the Close/Exit button. Its anticipated use is for a "help" button that launches a help message or dialog. But it can be any valid JComponent that doesn't mind co-existing among a bunch of JButtons.

    • closeTool

      public void closeTool()
      Disconnect the tool from registers/memory and close the tool's dialog. This calls stopObserving(), then handleClose(), then closes the actual dialog.