Package adams.doc.latex.generator
Class MultiGenerator
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.doc.latex.generator.AbstractCodeGenerator
-
- adams.doc.latex.generator.MultiGenerator
-
- 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 MultiGenerator extends AbstractCodeGenerator
Appends the output of the specified generators to the document.
-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> [-generator ...] (property: generators) The generators to use for appending the document. default:
- Version:
- $Revision$
- Author:
- FracPete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected CodeGenerator[]m_Generatorsthe generators to use.-
Fields inherited from class adams.doc.latex.generator.AbstractCodeGenerator
m_FlowContext, m_NoVariableExpansion, m_Skip
-
-
Constructor Summary
Constructors Constructor Description MultiGenerator()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddefineOptions()Adds options to the internal list of options.protected StringdoGenerate()Generates the actual code.StringgeneratorsTipText()Returns the tip text for this property.CodeGenerator[]getGenerators()Returns the generators to use.String[]getRequiredPackages()Returns the list of required LaTeX packages for this code generator.StringglobalInfo()Returns a string describing the object.voidsetGenerators(CodeGenerator[] value)Sets the generators to use.-
Methods inherited from class adams.doc.latex.generator.AbstractCodeGenerator
check, ensureTrailingNewLine, ensureTrailingNewLine, escape, expand, expandEscape, generate, getAdditionalInformation, getFlowContext, getNoVariableExpansion, getQuickInfo, getSkip, noVariableExpansionTipText, setFlowContext, setNoVariableExpansion, setSkip, skipTipText
-
Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString
-
Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf
-
-
-
-
Field Detail
-
m_Generators
protected CodeGenerator[] m_Generators
the generators to use.
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfoin interfaceadams.core.GlobalInfoSupporter- Specified by:
globalInfoin classadams.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:
defineOptionsin interfaceadams.core.option.OptionHandler- Overrides:
defineOptionsin classAbstractCodeGenerator
-
setGenerators
public void setGenerators(CodeGenerator[] value)
Sets the generators to use.- Parameters:
value- the generators
-
getGenerators
public CodeGenerator[] getGenerators()
Returns the generators to use.- Returns:
- the generators
-
generatorsTipText
public String generatorsTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
getRequiredPackages
public String[] getRequiredPackages()
Returns the list of required LaTeX packages for this code generator.- Specified by:
getRequiredPackagesin interfaceCodeGenerator- Specified by:
getRequiredPackagesin classAbstractCodeGenerator- Returns:
- the packages
-
doGenerate
protected String doGenerate()
Generates the actual code.- Specified by:
doGeneratein classAbstractCodeGenerator- Returns:
- the generated code
-
-