Class CircleBackground

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

      Modifier and Type Field Description
      protected int m_Radius
      the radius.
      • Fields inherited from class adams.core.option.AbstractOptionHandler

      • 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. generate​(adams.core.MessageCollection errors)
      Generates the background.
      int getRadius()
      Returns the radius for the background.
      String globalInfo()
      Returns a string describing the object.
      String radiusTipText()
      Returns the tip text for this property.
      void setRadius​(int value)
      Sets the radius for the background.
      • 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

    • Field Detail

      • m_Radius

        protected int m_Radius
        the radius.
    • Constructor Detail

      • CircleBackground

        public CircleBackground()
    • 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
        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
        defineOptions in class adams.core.option.AbstractOptionHandler
      • setRadius

        public void setRadius​(int value)
        Sets the radius for the background.
        value - the radius
      • getRadius

        public int getRadius()
        Returns the radius for the background.
        the radius
      • radiusTipText

        public String radiusTipText()
        Returns the tip text for this property.
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • generate

        public generate​(adams.core.MessageCollection errors)
        Generates the background.
        Specified by:
        generate in class AbstractBackground
        errors - for collecting errors
        the background, null if none generated