Package adams.doc.latex.generator

Class Include

  • 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 Include
extends AbstractFileReferencingCodeGenerator
    Includes the specified LaTeX file. 

    -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
 
    -path-type <ABSOLUTE|BASENAME|SUPPLIED_DIR> (property: pathType)
    Determines how to process the file name.
    default: ABSOLUTE
 
    -supplied-dir <java.lang.String> (property: suppliedDir)
    The directory name to use instead.
    default: 
 
    -remove-extension <boolean> (property: removeExtension)
    If enabled, removes the extension from the filename.
    default: true
 
    -include <adams.core.io.PlaceholderFile> (property: include)
    The LaTeX file to include.
    default: ${CWD}
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Include

        protected adams.core.io.PlaceholderFile m_Include
        the file to include.

    • Constructor Detail

      • Include

        public Include()

    • 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

      • setInclude

        public void setInclude​(adams.core.io.PlaceholderFile value)
        Sets the LaTeX file to include.
        Parameters:
        value - the file

      • getInclude

        public adams.core.io.PlaceholderFile getInclude()
        Returns the LaTeX file to include.
        Returns:
        the file

      • includeTipText

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