Package adams.doc.latex.generator

Class MultiCol

  • 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 MultiCol
extends AbstractMetaCodeGenerator
    Inserts a 'multicol' environment, providing multiple columns and an optional preface across the columns. 

    -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
 
    -generator <adams.doc.latex.generator.CodeGenerator> (property: generator)
    Generates the code for the columns.
    default: adams.doc.latex.generator.CustomStatements
 
    -preface <adams.doc.latex.generator.CodeGenerator> (property: preface)
    The optional code generator for the preface; use adams.doc.latex.generator.Dummy 
    to skip.
    default: adams.doc.latex.generator.Dummy
 
    -num-columns <int> (property: numColumns)
    The number of columns to use.
    default: 2
    minimum: 1
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Preface

        protected CodeGenerator m_Preface
        optional preface code generator.

      • m_NumColumns

        protected int m_NumColumns
        the number of columns.

    • Constructor Detail

      • MultiCol

        public MultiCol()

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

      • generatorTipText

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

      • setPreface

        public void setPreface​(CodeGenerator value)
        Sets the optional preface code generator.
        Parameters:
        value - the preface

      • getPreface

        public CodeGenerator getPreface()
        Returns the preface code generator.
        Returns:
        the preface

      • prefaceTipText

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

      • setNumColumns

        public void setNumColumns​(int value)
        Sets the number of columns to use.
        Parameters:
        value - the columns

      • getNumColumns

        public int getNumColumns()
        Returns the number of columns to use.
        Returns:
        the columns

      • numColumnsTipText

        public String numColumnsTipText()
        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 AbstractMetaCodeGenerator
        Returns:
        null if no info available, otherwise short string