Package adams.doc.latex.generator

Class Verbatim

  • 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, EnvironmentWithNoTrailingSpace, adams.flow.core.FlowContextHandler, Serializable
    public class Verbatim
extends AbstractEnvironmentWithNoTrailingSpace
    Outputs the specified statements in a verbatim block. 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
 
    -skip <boolean> (property: skip)
    If enabled, the code generation gets skipped.
    default: false
 
    -no-var-expansion <boolean> (property: noVariableExpansion)
    If enabled, variable expansion gets skipped.
    default: false
 
    -suppress-trailing-space <boolean> (property: suppressTrailingSpace)
    If enabled, adds a '%' to suppress the trailing space.
    default: false
 
    -statements <adams.core.base.BaseText> (property: statements)
    The statements to insert as verbatim block.
    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 add in verbatim.

    • Constructor Detail

      • Verbatim

        public Verbatim()

    • 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

      • setStatements

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

      • getStatements

        public adams.core.base.BaseText getStatements()
        Returns the statements to insert as verbatim.
        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.