Package adams.gui.visualization.heatmap.overlay

Class AbstractPositionableHeatmapOverlayWithDimensions

  • All Implemented Interfaces:
    adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.ShallowCopySupporter<adams.gui.visualization.image.AbstractImageOverlay>, adams.core.SizeOfHandler, adams.gui.visualization.image.ImageOverlay, Serializable
    Direct Known Subclasses:
    TextOverlay
    public abstract class AbstractPositionableHeatmapOverlayWithDimensions
extends AbstractPositionableHeatmapOverlay
    Ancestor for overlays that can be positioned on the heatmap panel and support dimensions.
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected int m_Height
      the height of the overlay.
      protected int m_Width
      the width of the overlay.

      • Fields inherited from class adams.gui.visualization.image.AbstractImageOverlay

        m_Enabled

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      protected void doPaintOverlay​(adams.gui.visualization.image.ImagePanel.PaintPanel panel, Graphics g)
      Computes the actual coordinates before doing the actual painting.
      protected abstract void doPaintOverlay​(adams.gui.visualization.image.ImagePanel.PaintPanel panel, Graphics g, int x, int y)
      Performs the actual painting.
      protected abstract int getDefaultHeight()
      Returns the default height for the overlay.
      protected abstract int getDefaultWidth()
      Returns the default width for the overlay.
      int getHeight()
      Returns the currently set height of the overlay.
      int getWidth()
      Returns the currently set width of the overlay.
      abstract String heightTipText()
      Returns the tip text for this property.
      void setHeight​(int value)
      Sets the height of the overlay.
      void setWidth​(int value)
      Sets the width of the overlay.
      abstract String widthTipText()
      Returns the tip text for this property.

      • Methods inherited from class adams.gui.visualization.image.AbstractImageOverlay

        cleanUp, doImageChanged, enabledTipText, imageChanged, isEnabled, overlayAdded, overlayRemoved, setEnabled, shallowCopy, shallowCopy

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

      • Methods inherited from interface adams.core.Destroyable

        destroy

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel

      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, getOptionManager, toCommandLine

    • Field Detail

      • m_Width

        protected int m_Width
        the width of the overlay.

      • m_Height

        protected int m_Height
        the height of the overlay.

    • Constructor Detail

      • AbstractPositionableHeatmapOverlayWithDimensions

        public AbstractPositionableHeatmapOverlayWithDimensions()

    • Method Detail

      • defineOptions

        public void defineOptions()
        Adds options to the internal list of options.
        Specified by:
        defineOptions in interface adams.core.option.OptionHandler
        Overrides:
        defineOptions in class AbstractPositionableHeatmapOverlay

      • getDefaultWidth

        protected abstract int getDefaultWidth()
        Returns the default width for the overlay.
        Returns:
        the default width

      • setWidth

        public void setWidth​(int value)
        Sets the width of the overlay.
        Parameters:
        value - the width

      • widthTipText

        public abstract String widthTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • getDefaultHeight

        protected abstract int getDefaultHeight()
        Returns the default height for the overlay.
        Returns:
        the default height

      • setHeight

        public void setHeight​(int value)
        Sets the height of the overlay.
        Parameters:
        value - the height

      • heightTipText

        public abstract String heightTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • doPaintOverlay

        protected abstract void doPaintOverlay​(adams.gui.visualization.image.ImagePanel.PaintPanel panel,
                                       Graphics g,
                                       int x,
                                       int y)
        Performs the actual painting.
        Specified by:
        doPaintOverlay in class AbstractPositionableHeatmapOverlay
        Parameters:
        panel - the associated viewer
        g - the graphics context
        x - the actual x coordinate
        y - the actual y coordinate