Package adams.gui.visualization.timeseries

Class FixedTimestampRangePaintlet

  • All Implemented Interfaces:
    Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<Paintlet>, SizeOfHandler, Paintlet, Serializable
    public class FixedTimestampRangePaintlet
extends AbstractTimeseriesPaintlet
    Paintlet for highlighting a specific timestamp range with a background color. 

    -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
 
    -start-timestamp <adams.core.base.BaseDateTime> (property: startTimestamp)
    The timestamp indicating the start of the range.
    default: NOW
 
    -end-timestamp <adams.core.base.BaseDateTime> (property: endTimestamp)
    The timestamp indicating the end of the range.
    default: NOW
 
    -color <java.awt.Color> (property: color)
    The color of the selected range.
    default: #D8D8D8
    Version:
    $Revision: 7297 $
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_StartTimestamp

        protected BaseDateTime m_StartTimestamp
        the start timestamp of the range.

      • m_EndTimestamp

        protected BaseDateTime m_EndTimestamp
        the end timestamp of the range.

      • m_Color

        protected Color m_Color
        the color to paint the point with.

    • Constructor Detail

      • FixedTimestampRangePaintlet

        public FixedTimestampRangePaintlet()

    • Method Detail

      • setStartTimestamp

        public void setStartTimestamp​(BaseDateTime value)
        Sets the timestamp for the start of the range.
        Parameters:
        value - the timestamp

      • getStartTimestamp

        public BaseDateTime getStartTimestamp()
        Returns the timestamp for the start of the range.
        Returns:
        the timestamp

      • startTimestampTipText

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

      • setEndTimestamp

        public void setEndTimestamp​(BaseDateTime value)
        Sets the timestamp for the end of the range.
        Parameters:
        value - the timestamp

      • getEndTimestamp

        public BaseDateTime getEndTimestamp()
        Returns the timestamp for the end of the range.
        Returns:
        the timestamp

      • endTimestampTipText

        public String endTimestampTipText()
        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 range with.
        Parameters:
        value - the color

      • getColor

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