Package adams.gui.visualization.object.annotator

Class SAMMarkers

  • 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.SizeOfHandler, Serializable
    public class SAMMarkers
extends adams.gui.visualization.object.annotator.AbstractAnnotator
    Annotator plugin that works only in conjunction with the SAM tool.
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SAMMarkers.Shape
      Enum for the marker shape to plot around the marker points.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected Color m_Color
      the color for the markers.
      protected int m_Extent
      the maximum width/height of the shape to plot around the marker points.
      protected KeyListener m_KeyListener
      the key listener.
      protected MouseListener m_MouseListener
      the mouse listener.
      protected List<Point> m_Points
      the points.
      protected SAMMarkers.Shape m_Shape
      the marker shape.
      protected SAM m_Tool
      the associated tool.

      • Fields inherited from class adams.gui.visualization.object.annotator.AbstractAnnotator

        m_Owner, m_Selecting

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

        m_OptionManager

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

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Constructor Summary

      Constructors 
      Constructor Description
      SAMMarkers()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String colorTipText()
      Returns the tip text for this property.
      void defineOptions()
      Adds options to the internal list of options.
      protected void doInstall()
      Installs the annotator with the owner.
      protected void doPaintSelection​(Graphics g)
      Paints the markers.
      protected void doUninstall()
      Uninstalls the annotator with the owner.
      String extentTipText()
      Returns the tip text for this property.
      Color getColor()
      Returns the color in use for point markers.
      int getExtent()
      Returns the size of the markers.
      SAMMarkers.Shape getShape()
      Returns the shape in use for markers.
      SAM getTool()
      Returns the associated tool.
      String globalInfo()
      Returns a string describing the object.
      protected void initialize()
      Initializes the members.
      void setColor​(Color value)
      Sets the color to use for point markers.
      void setExtent​(int value)
      Sets the size of the markers.
      void setShape​(SAMMarkers.Shape value)
      Sets the shape to use for markers.
      void setTool​(SAM value)
      Sets the associated tool.
      String shapeTipText()
      Returns the tip text for this property.

      • Methods inherited from class adams.gui.visualization.object.annotator.AbstractAnnotator

        annotationsChanged, applyStroke, cleanUp, getCurrentLabel, getOwner, getStrokeWidth, hasCurrentLabel, install, labelChanged, paintSelection, setOwner, uninstall

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

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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.logging.LoggingLevelHandler

        getLoggingLevel

    • Field Detail

      • m_Color

        protected Color m_Color
        the color for the markers.

      • m_Extent

        protected int m_Extent
        the maximum width/height of the shape to plot around the marker points.

      • m_Points

        protected List<Point> m_Points
        the points.

      • m_MouseListener

        protected MouseListener m_MouseListener
        the mouse listener.

      • m_KeyListener

        protected KeyListener m_KeyListener
        the key listener.

      • m_Tool

        protected SAM m_Tool
        the associated tool.

    • Constructor Detail

      • SAMMarkers

        public SAMMarkers()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • 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 adams.core.option.AbstractOptionHandler

      • initialize

        protected void initialize()
        Initializes the members.
        Overrides:
        initialize in class adams.gui.visualization.object.annotator.AbstractAnnotator

      • setShape

        public void setShape​(SAMMarkers.Shape value)
        Sets the shape to use for markers.
        Parameters:
        value - the shape

      • getShape

        public SAMMarkers.Shape getShape()
        Returns the shape in use for markers.
        Returns:
        the shape

      • shapeTipText

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

      • setColor

        public void setColor​(Color value)
        Sets the color to use for point markers.
        Parameters:
        value - the color

      • getColor

        public Color getColor()
        Returns the color in use for point markers.
        Returns:
        the color

      • colorTipText

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

      • setExtent

        public void setExtent​(int value)
        Sets the size of the markers.
        Parameters:
        value - the extent

      • getExtent

        public int getExtent()
        Returns the size of the markers.
        Returns:
        the extent

      • extentTipText

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

      • setTool

        public void setTool​(SAM value)
        Sets the associated tool.
        Parameters:
        value - the tool

      • getTool

        public SAM getTool()
        Returns the associated tool.
        Returns:
        the tool

      • doInstall

        protected void doInstall()
        Installs the annotator with the owner.
        Specified by:
        doInstall in class adams.gui.visualization.object.annotator.AbstractAnnotator

      • doUninstall

        protected void doUninstall()
        Uninstalls the annotator with the owner.
        Specified by:
        doUninstall in class adams.gui.visualization.object.annotator.AbstractAnnotator

      • doPaintSelection

        protected void doPaintSelection​(Graphics g)
        Paints the markers.
        Specified by:
        doPaintSelection in class adams.gui.visualization.object.annotator.AbstractAnnotator
        Parameters:
        g - the graphics context