Package adams.doc.latex.generator

Class CustomStatements

  • 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
    public class CustomStatements
extends AbstractCodeGenerator
    Simply outputs the specified statements. Variables get expanded. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -no-var-expansion <boolean> (property: noVariableExpansion)
    If enabled, variable expansion gets skipped.
    default: false
 
    -statements <adams.core.base.BaseText> (property: statements)
    The custom statements to return (after variable expansion).
    default:
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Statements

        protected adams.core.base.BaseText m_Statements
        the statements to return.

    • Constructor Detail

      • CustomStatements

        public CustomStatements()

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

      • setStatements

        public void setStatements​(adams.core.base.BaseText value)
        Sets the custom statements to insert.
        Parameters:
        value - the statements

      • getStatements

        public adams.core.base.BaseText getStatements()
        Returns the custom statements to insert.
        Returns:
        the statements

      • statementsTipText

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