Package adams.doc.latex.generator

Class ImportContent

  • 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 ImportContent
extends AbstractCodeGenerator
    Imports the content of the specified file. By default, the content gets escaped to make it valid LaTeX. 

    -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
 
    -import <adams.core.io.PlaceholderFile> (property: import)
    The file to import the content from.
    default: ${CWD}
 
    -escape <boolean> (property: escape)
    If enabled, the content of the import file get escaped to make it valid 
    LaTeX.
    default: true
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Import

        protected adams.core.io.PlaceholderFile m_Import
        the file to import.

      • m_Escape

        protected boolean m_Escape
        whether to escape the content.

    • Constructor Detail

      • ImportContent

        public ImportContent()

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

      • setImport

        public void setImport​(adams.core.io.PlaceholderFile value)
        Sets the file to import the content.
        Parameters:
        value - the file

      • getImport

        public adams.core.io.PlaceholderFile getImport()
        Returns the file to import the content.
        Returns:
        the file

      • importTipText

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

      • setEscape

        public void setEscape​(boolean value)
        Sets whether to escape the content of the import file.
        Parameters:
        value - true if to escape

      • getEscape

        public boolean getEscape()
        Returns whether to escape the content of the import file.
        Returns:
        true if to escape

      • escapeTipText

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