Class OvalMapOverlay

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable

    public class OvalMapOverlay
    extends AbstractPositionableMapOverlayWithDimensions
    Paints an oval at the specified location.

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
        The logging level for outputting errors and debugging output.
        default: WARNING
     
    -enabled <boolean> (property: enabled)
        If enabled, the overlay gets painted.
        default: true
     
    -x <int> (property: x)
        The X position of the overlay (>=0: absolute, -1: left, -2: center, -3: 
        right).
        default: -3
        minimum: -3
     
    -y <int> (property: y)
        The Y position of the overlay (>=0: absolute, -1: top, -2: center, -3: bottom
        ).
        default: -1
        minimum: -3
     
    -width <int> (property: width)
        The width of the oval.
        default: 100
        minimum: -1
     
    -height <int> (property: height)
        The height of the oval.
        default: 20
        minimum: -1
     
    -border-enabled <boolean> (property: borderEnabled)
        If enabled, the border gets painted.
        default: true
     
    -border-color <java.awt.Color> (property: borderColor)
        The color of the border.
        default: #000000
     
    -fill-enabled <boolean> (property: fillEnabled)
        If enabled, the oval gets filled.
        default: true
     
    -fill-color <java.awt.Color> (property: fillColor)
        The fill color.
        default: #32646464
     
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Detail

      • m_BorderEnabled

        protected boolean m_BorderEnabled
        whether the border gets painted.
      • m_BorderColor

        protected Color m_BorderColor
        the color of the border.
      • m_FillEnabled

        protected boolean m_FillEnabled
        whether filling is enbaled.
      • m_FillColor

        protected Color m_FillColor
        the fill color.
    • Constructor Detail

      • OvalMapOverlay

        public OvalMapOverlay()
    • 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
      • setBorderEnabled

        public void setBorderEnabled​(boolean value)
        Sets whether to paint the border.
        Parameters:
        value - true if to paint border
      • getBorderEnabled

        public boolean getBorderEnabled()
        Returns whether the border gets painted.
        Returns:
        true if border painted
      • borderEnabledTipText

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

        public void setBorderColor​(Color value)
        Sets the color for the border.
        Parameters:
        value - the border color
      • getBorderColor

        public Color getBorderColor()
        Returns the color for the border.
        Returns:
        the border color
      • borderColorTipText

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

        public void setFillEnabled​(boolean value)
        Sets whether to fill the oval.
        Parameters:
        value - true if to fill
      • getFillEnabled

        public boolean getFillEnabled()
        Returns whether the oval is filled.
        Returns:
        true if filled
      • fillEnabledTipText

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

        public void setFillColor​(Color value)
        Sets the fill color.
        Parameters:
        value - the fill color
      • getFillColor

        public Color getFillColor()
        Returns the fill color.
        Returns:
        the fill color
      • fillColorTipText

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