Package adams.flow.transformer.wordcloud

Class ColorListPalette

  • 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 ColorListPalette
extends AbstractColorPalette
    Generates a color palette using the specified colors.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.core.base.BaseColor[] m_Colors
      the colors to use.

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

        m_OptionManager

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

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String colorsTipText()
      Returns the tip text for this property.
      void defineOptions()
      Adds options to the internal list of options.
      com.kennycason.kumo.palette.ColorPalette generate​(adams.core.MessageCollection errors)
      Generates the color palette.
      adams.core.base.BaseColor[] getColors()
      Returns the colors to create the palette from.
      String globalInfo()
      Returns a string describing the object.
      void setColors​(adams.core.base.BaseColor[] value)
      Sets the colors to create the palette from.

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

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, 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_Colors

        protected adams.core.base.BaseColor[] m_Colors
        the colors to use.

    • Constructor Detail

      • ColorListPalette

        public ColorListPalette()

    • 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

      • setColors

        public void setColors​(adams.core.base.BaseColor[] value)
        Sets the colors to create the palette from.
        Parameters:
        value - the colors

      • getColors

        public adams.core.base.BaseColor[] getColors()
        Returns the colors to create the palette from.
        Returns:
        the colors

      • colorsTipText

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

      • generate

        public com.kennycason.kumo.palette.ColorPalette generate​(adams.core.MessageCollection errors)
        Generates the color palette.
        Specified by:
        generate in class AbstractColorPalette
        Parameters:
        errors - for collecting errors
        Returns:
        the color palette, null if none generated