Package adams.doc.latex.generator

Class BlockSize

  • 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 BlockSize
extends AbstractMetaCodeGenerator
    Inserts the code from the base generator inside a block with the specified font size. 

    -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
 
    -generator <adams.doc.latex.generator.CodeGenerator> (property: generator)
    Generates the code for the differently sized block.
    default: adams.doc.latex.generator.Verbatim
 
    -font-size <tiny|scriptsize|footnotesize|small|normalsize|large|Large|LARGE|huge|Huge> (property: fontSize)
    The font size to use for the encapsulated block.
    default: normalsize
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Constructor Detail

      • BlockSize

        public BlockSize()

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

      • setFontSize

        public void setFontSize​(BlockSize.FontSize value)
        Sets the font size for the block.
        Parameters:
        value - the size

      • getFontSize

        public BlockSize.FontSize getFontSize()
        Returns the font size for the block.
        Returns:
        the size

      • fontSizeTipText

        public String fontSizeTipText()
        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