Package adams.gui.visualization.spectrum

Class SpectrumPaintletStringField

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.ShallowCopySupporter<adams.gui.visualization.core.Paintlet>, adams.core.SizeOfHandler, adams.gui.core.AntiAliasingSupporter, adams.gui.visualization.core.ColorProviderHandler, adams.gui.visualization.core.Paintlet, adams.gui.visualization.core.PaintletWithMarkers, Serializable
    public class SpectrumPaintletStringField
extends SpectrumPaintlet
implements adams.gui.visualization.core.ColorProviderHandler
    Paintlet for painting the spectral graph. Colors are determined by the value extracted from the specified string field in the report.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Field

        protected adams.data.report.Field m_Field
        the report field to get the string value from.

      • m_RegExp

        protected adams.core.base.BaseRegExp m_RegExp
        the regular expression to apply (extracts first group).

      • m_ColorProvider

        protected adams.gui.visualization.core.ColorProvider m_ColorProvider
        the color provider to use.

      • m_DefaultColor

        protected Color m_DefaultColor
        the default color if field is missing.

    • Constructor Detail

      • SpectrumPaintletStringField

        public SpectrumPaintletStringField()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Overrides:
        globalInfo in class SpectrumPaintlet
        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 SpectrumPaintlet

      • setField

        public void setField​(adams.data.report.Field value)
        Sets the string field to determine the color with.
        Parameters:
        value - the string field

      • getField

        public adams.data.report.Field getField()
        Returns the string field to determine the color with.
        Returns:
        the string field

      • fieldTipText

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

      • setRegExp

        public void setRegExp​(adams.core.base.BaseRegExp value)
        Sets regular expression to apply to the string field; the string obtained from the first group is associated with a color.
        Parameters:
        value - the expression

      • getRegExp

        public adams.core.base.BaseRegExp getRegExp()
        Returns regular expression to apply to the string field; the string obtained from the first group is associated with a color.
        Returns:
        the expression

      • regExpTipText

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

      • setColorProvider

        public void setColorProvider​(adams.gui.visualization.core.ColorProvider value)
        Sets the color provider to use.
        Specified by:
        setColorProvider in interface adams.gui.visualization.core.ColorProviderHandler
        Parameters:
        value - the color provider

      • getColorProvider

        public adams.gui.visualization.core.ColorProvider getColorProvider()
        Returns the color provider in use.
        Specified by:
        getColorProvider in interface adams.gui.visualization.core.ColorProviderHandler
        Returns:
        the color provider

      • colorProviderTipText

        public String colorProviderTipText()
        Returns the tip text for this property.
        Specified by:
        colorProviderTipText in interface adams.gui.visualization.core.ColorProviderHandler
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setDefaultColor

        public void setDefaultColor​(Color value)
        Sets the default color to use when then report field is missing or invalid.
        Parameters:
        value - the color

      • getDefaultColor

        public Color getDefaultColor()
        Returns the default color to use when then report field is missing or invalid.
        Returns:
        the color

      • defaultColorTipText

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

      • getColor

        public Color getColor​(int index)
        Returns the color for the data with the given index.
        Overrides:
        getColor in class SpectrumPaintlet
        Parameters:
        index - the index of the spectrum
        Returns:
        the color for the spectrum