Package adams.gui.visualization.timeseries

Class FixedTimestampPaintlet

  • All Implemented Interfaces:
    Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<Paintlet>, SizeOfHandler, Paintlet, Serializable
    public class FixedTimestampPaintlet
extends AbstractTimeseriesPaintlet
    Paintlet for highlighting a specific timestamp with a vertical indicator line. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -stroke-thickness <float> (property: strokeThickness)
    The thickness of the stroke.
    default: 1.0
    minimum: 0.01
 
    -timestamp <adams.core.base.BaseDateTime> (property: timestamp)
    The timestamp to indicate.
    default: NOW
 
    -prefix <java.lang.String> (property: prefix)
    The prefix to use for the date label printed next to the indicator.
    default: 
 
    -offset-x <int> (property: offsetX)
    The number of pixels to offset the string from the left of the indicator.
    default: 10
 
    -offset-y <int> (property: offsetY)
    The number of pixels to offset the string from the top of the panel.
    default: 10
    minimum: 0
 
    -color <java.awt.Color> (property: color)
    The color of the indicator/text.
    default: #ff0000
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Timestamp

        protected BaseDateTime m_Timestamp
        the timestamp to indicate.

      • m_Prefix

        protected String m_Prefix
        the prefix for the date label.

      • m_OffsetY

        protected int m_OffsetY
        the pixel offset from the top.

      • m_OffsetX

        protected int m_OffsetX
        the pixel offset from the left.

      • m_Color

        protected Color m_Color
        the color to paint the point with.

    • Constructor Detail

      • FixedTimestampPaintlet

        public FixedTimestampPaintlet()

    • Method Detail

      • setTimestamp

        public void setTimestamp​(BaseDateTime value)
        Sets the timestamp to indicate.
        Parameters:
        value - the timestamp

      • getTimestamp

        public BaseDateTime getTimestamp()
        Returns the currently set timestamp to indicate.
        Returns:
        the timestamp

      • timestampTipText

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

      • setPrefix

        public void setPrefix​(String value)
        Sets the prefix for the date label.
        Parameters:
        value - the prefix

      • getPrefix

        public String getPrefix()
        Returns the currently set prefix for the date label.
        Returns:
        the prefix

      • prefixTipText

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

      • setOffsetX

        public void setOffsetX​(int value)
        Sets the pixel offset from the left.
        Parameters:
        value - the offset

      • getOffsetX

        public int getOffsetX()
        Returns the pixel offset from the left.
        Returns:
        the offset

      • offsetXTipText

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

      • setOffsetY

        public void setOffsetY​(int value)
        Sets the pixel offset from the top.
        Parameters:
        value - the offset

      • getOffsetY

        public int getOffsetY()
        Returns the pixel offset from the top.
        Returns:
        the offset

      • offsetYTipText

        public String offsetYTipText()
        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 paint the point with.
        Parameters:
        value - the color

      • getColor

        public Color getColor()
        Returns the currently set color to paint the point with.
        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.