Package adams.flow.transformer.wordcloud

Class PixelBoundaryBackground

  • 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 PixelBoundaryBackground
extends AbstractBackground
    Generates a background mode based on the transparent pixel-boundaries of the specified image.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.core.io.PlaceholderFile m_Background
      the background image.

      • 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 backgroundTipText()
      Returns the tip text for this property.
      void defineOptions()
      Adds options to the internal list of options.
      com.kennycason.kumo.bg.Background generate​(adams.core.MessageCollection errors)
      Generates the background.
      adams.core.io.PlaceholderFile getBackground()
      Returns the background image to use.
      String globalInfo()
      Returns a string describing the object.
      void setBackground​(adams.core.io.PlaceholderFile value)
      Sets the background image to use.

      • 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_Background

        protected adams.core.io.PlaceholderFile m_Background
        the background image.

    • Constructor Detail

      • PixelBoundaryBackground

        public PixelBoundaryBackground()

    • 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

      • setBackground

        public void setBackground​(adams.core.io.PlaceholderFile value)
        Sets the background image to use.
        Parameters:
        value - the image

      • getBackground

        public adams.core.io.PlaceholderFile getBackground()
        Returns the background image to use.
        Returns:
        the image

      • backgroundTipText

        public String backgroundTipText()
        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.bg.Background generate​(adams.core.MessageCollection errors)
        Generates the background.
        Specified by:
        generate in class AbstractBackground
        Parameters:
        errors - for collecting errors
        Returns:
        the background, null if none generated