Package adams.doc.latex.generator

Class MiniPage

  • 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 MiniPage
extends AbstractMetaCodeGeneratorWithNoTrailingSpace
    Inserts a minipage environment. 

    -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 minipage.
    default: adams.doc.latex.generator.Figure -generator adams.doc.latex.generator.Image
 
    -suppress-trailing-space <boolean> (property: suppressTrailingSpace)
    If enabled, adds a '%' to suppress the trailing space.
    default: false
 
    -position <java.lang.String> (property: position)
    The optional position parameter.
    default: 
 
    -width <java.lang.String> (property: width)
    The width for the minipage.
    default: 0.5\\linewidth
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Position

        protected String m_Position
        the optional position.

      • m_Width

        protected String m_Width
        the width.

    • Constructor Detail

      • MiniPage

        public MiniPage()

    • 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

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

      • setPosition

        public void setPosition​(String value)
        Sets the (optional) position to use.
        Parameters:
        value - the position

      • getPosition

        public String getPosition()
        Returns the (optional) position to use.
        Returns:
        the position

      • positionTipText

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

      • setWidth

        public void setWidth​(String value)
        Sets the width.
        Parameters:
        value - the width

      • getWidth

        public String getWidth()
        Returns the width.
        Returns:
        the width

      • widthTipText

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