Package adams.flow.transformer.wordcloud

Class RectangleBackground

  • 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 RectangleBackground
extends AbstractBackground
    Generates a rectangular background.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected int m_Height
      the height.
      protected int m_Width
      the width.
      protected int m_X
      the x.
      protected int m_Y
      the y.

      • 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
      void defineOptions()
      Adds options to the internal list of options.
      com.kennycason.kumo.bg.Background generate​(adams.core.MessageCollection errors)
      Generates the background.
      int getHeight()
      Returns the height for the background.
      int getWidth()
      Returns the width for the background.
      int getX()
      Returns the x for the background.
      int getY()
      Returns the y for the background.
      String globalInfo()
      Returns a string describing the object.
      String heightTipText()
      Returns the tip text for this property.
      void setHeight​(int value)
      Sets the height for the background.
      void setWidth​(int value)
      Sets the width for the background.
      void setX​(int value)
      Sets the x for the background.
      void setY​(int value)
      Sets the y for the background.
      String widthTipText()
      Returns the tip text for this property.
      String XTipText()
      Returns the tip text for this property.
      String YTipText()
      Returns the tip text for this property.

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

        protected int m_X
        the x.

      • m_Y

        protected int m_Y
        the y.

      • m_Width

        protected int m_Width
        the width.

      • m_Height

        protected int m_Height
        the height.

    • Constructor Detail

      • RectangleBackground

        public RectangleBackground()

    • 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

      • setX

        public void setX​(int value)
        Sets the x for the background.
        Parameters:
        value - the x

      • getX

        public int getX()
        Returns the x for the background.
        Returns:
        the x

      • XTipText

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

      • setY

        public void setY​(int value)
        Sets the y for the background.
        Parameters:
        value - the y

      • getY

        public int getY()
        Returns the y for the background.
        Returns:
        the y

      • YTipText

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

      • setWidth

        public void setWidth​(int value)
        Sets the width for the background.
        Parameters:
        value - the width

      • getWidth

        public int getWidth()
        Returns the width for the background.
        Returns:
        the width

      • widthTipText

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

      • setHeight

        public void setHeight​(int value)
        Sets the height for the background.
        Parameters:
        value - the height

      • getHeight

        public int getHeight()
        Returns the height for the background.
        Returns:
        the height

      • heightTipText

        public String heightTipText()
        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 failed