Package adams.doc.latex.generator

Class Figure

  • 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 Figure
extends AbstractMetaCodeGenerator
    Inserts a figure with the code generated by the base generator. 

    -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 figure.
    default: adams.doc.latex.generator.Image
 
    -options <java.lang.String> (property: options)
    The options for the figure.
    default: 
 
    -center <boolean> (property: center)
    Whether to center the figure.
    default: false
 
    -caption <java.lang.String> (property: caption)
    The caption of the figure.
    default: 
 
    -label <java.lang.String> (property: label)
    The optional label of the figure (for cross-referencing).
    default:
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Options

        protected String m_Options
        optional parameters for the image.

      • m_Center

        protected boolean m_Center
        whether to center the figure.

      • m_Caption

        protected String m_Caption
        the caption of the section.

      • m_Label

        protected String m_Label
        the (optional) label for the section.

    • Constructor Detail

      • Figure

        public Figure()

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

      • setOptions

        public void setOptions​(String value)
        Sets the options to use for the figure.
        Parameters:
        value - the options

      • getOptions

        public String getOptions()
        Returns the options to use for the figure.
        Returns:
        the options

      • optionsTipText

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

      • setCenter

        public void setCenter​(boolean value)
        Sets whether to center the figure.
        Parameters:
        value - true if to center

      • getCenter

        public boolean getCenter()
        Returns whether to center the figure.
        Returns:
        true if to center

      • centerTipText

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

      • setCaption

        public void setCaption​(String value)
        Sets the caption.
        Parameters:
        value - the caption

      • getCaption

        public String getCaption()
        Returns the caption.
        Returns:
        the caption

      • captionTipText

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

      • setLabel

        public void setLabel​(String value)
        Sets the label.
        Parameters:
        value - the label

      • getLabel

        public String getLabel()
        Returns the label.
        Returns:
        the label

      • labelTipText

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