Class AbstractInspectorPanelController

java.lang.Object
org.micromanager.display.inspector.AbstractInspectorPanelController
All Implemented Interfaces:
InspectorPanelController

public abstract class AbstractInspectorPanelController extends Object implements InspectorPanelController
A panel containing a section of the inspector window.

In addition to implementing this abstract class, inspector panels must call the appropriate methods of Inspector to notify the latter of certain changes.

  • Constructor Details

    • AbstractInspectorPanelController

      public AbstractInspectorPanelController()
  • Method Details

    • addInspectorPanelListener

      public final void addInspectorPanelListener(InspectorPanelListener listener)
      Specified by:
      addInspectorPanelListener in interface InspectorPanelController
    • removeInspectorPanelListener

      public final void removeInspectorPanelListener(InspectorPanelListener listener)
      Specified by:
      removeInspectorPanelListener in interface InspectorPanelController
    • fireInspectorPanelWillChangeHeight

      protected void fireInspectorPanelWillChangeHeight()
    • fireInspectorPanelDidChangeHeight

      protected void fireInspectorPanelDidChangeHeight()
    • fireInspectorPanelDidChangeTitle

      protected void fireInspectorPanelDidChangeTitle()
    • getTitle

      public abstract String getTitle()
      Specified by:
      getTitle in interface InspectorPanelController
    • getGearMenu

      public JPopupMenu getGearMenu()
      Provide a menu used for miscellaneous controls. This menu will be attached to a "gear button" visible in the title bar, when this panel is currently open. May be null, in which case no gear button will be shown. This method is called when the panel is first added to the inspector to determine if the button should be used; then when the button is clicked, the method is called again, in case you need to re-generate your menu based on context (e.g. changes in display settings).

      It is permissible to always return the same JPopupMenu instance, as long as you ensure that it is updated each time this method is called.

      This method is guaranteed to be called on the Swing/AWT event dispatch thread.

      Specified by:
      getGearMenu in interface InspectorPanelController
      Returns:
      the gear popup menu, or null if the panel does not use a gear menu
    • attachDataViewer

      public abstract void attachDataViewer(DataViewer viewer)
      Attach to a data viewer.
      Specified by:
      attachDataViewer in interface InspectorPanelController
      Parameters:
      viewer - a DataViewer (never null)
    • detachDataViewer

      public abstract void detachDataViewer()
      Detach from any currently attached data viewer. This method should not throw an exception if a viewer is not yet attached.
      Specified by:
      detachDataViewer in interface InspectorPanelController
    • isVerticallyResizableByUser

      public abstract boolean isVerticallyResizableByUser()
      Indicate whether the panel can be resized vertically by the user.

      Note that this is independent of whether the panel resizes itself depending on its content.

      Specified by:
      isVerticallyResizableByUser in interface InspectorPanelController
      Returns:
      true if the panel can be resized vertically; false if the panel has a fixed height