Package adams.doc.latex.generator

Class AbstractMetaCodeGenerator

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.SizeOfHandler, CodeGenerator, adams.flow.core.FlowContextHandler, Serializable
    Direct Known Subclasses:
    AbstractMetaCodeGeneratorWithNoTrailingSpace, BlockSize, Figure, MultiCol
    public abstract class AbstractMetaCodeGenerator
extends AbstractCodeGenerator
    Ancestor for generators that enhance another base generator.
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Generator

        protected CodeGenerator m_Generator
        the base generator to use.

    • Constructor Detail

      • AbstractMetaCodeGenerator

        public AbstractMetaCodeGenerator()

    • Method Detail

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

      • getDefaultGenerator

        protected abstract CodeGenerator getDefaultGenerator()
        Returns the default code generator to use.
        Returns:
        the default

      • setGenerator

        public void setGenerator​(CodeGenerator value)
        Sets the base generator to use.
        Parameters:
        value - the generator

      • getGenerator

        public CodeGenerator getGenerator()
        Returns the base generator to use.
        Returns:
        the generator

      • setFlowContext

        public void setFlowContext​(adams.flow.core.Actor value)
        Sets the flow context.
        Specified by:
        setFlowContext in interface CodeGenerator
        Specified by:
        setFlowContext in interface adams.flow.core.FlowContextHandler
        Overrides:
        setFlowContext in class AbstractCodeGenerator
        Parameters:
        value - the actor

      • generatorTipText

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

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the object, which can be displayed in the GUI.
        Specified by:
        getQuickInfo in interface CodeGenerator
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class AbstractCodeGenerator
        Returns:
        null if no info available, otherwise short string