Package adams.doc.latex.generator

Interface CodeGenerator

All Superinterfaces:

adams.core.AdditionalInformationHandler, adams.core.Destroyable, adams.flow.core.FlowContextHandler, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter

All Known Subinterfaces:

EnvironmentWithNoTrailingSpace

All Known Implementing Classes:

AbstractCodeGenerator, AbstractEnvironmentWithNoTrailingSpace, AbstractFileReferencingCodeGenerator, AbstractMetaCodeGenerator, AbstractMetaCodeGeneratorWithNoTrailingSpace, BlockSize, ClearPage, CustomStatements, Dummy, Figure, Image, ImportContent, Include, Input, ListOfFigures, ListOfTables, MiniPage, MultiCol, MultiGenerator, NewPage, NewSection, Table, TableOfContents, Verbatim

public interface CodeGenerator
extends adams.core.option.OptionHandler, adams.flow.core.FlowContextHandler, adams.core.QuickInfoSupporter, adams.core.AdditionalInformationHandler

Interface for LaTeX code generators.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
String	generate()	Generates the code.
String	getAdditionalInformation()	Returns the additional information.
adams.flow.core.Actor	getFlowContext()	Returns the flow context, if any.
boolean	getNoVariableExpansion()	Returns whether to skip variable expansion.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String[]	getRequiredPackages()	Returns the list of required LaTeX packages for this code generator.
boolean	getSkip()	Returns whether the generator is skipped.
String	noVariableExpansionTipText()	Returns the tip text for this property.
void	setFlowContext(adams.flow.core.Actor value)	Sets the flow context.
void	setNoVariableExpansion(boolean value)	Sets whether to skip variable expansion.
void	setSkip(boolean value)	Sets whether the generator is skipped.
String	skipTipText()	Returns the tip text for this property.

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Method Detail

setSkip

void setSkip(boolean value)

Sets whether the generator is skipped.

Parameters:

value - true if generation is to be skipped

getSkip

boolean getSkip()

Returns whether the generator is skipped.

Returns:

true if generation is skipped

skipTipText

String skipTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setNoVariableExpansion

void setNoVariableExpansion(boolean value)

Sets whether to skip variable expansion.

Parameters:

value - true if to skip

getNoVariableExpansion

boolean getNoVariableExpansion()

Returns whether to skip variable expansion.

Returns:

true if to skip

noVariableExpansionTipText

String noVariableExpansionTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setFlowContext

void setFlowContext(adams.flow.core.Actor value)

Sets the flow context.

Specified by:

setFlowContext in interface adams.flow.core.FlowContextHandler

Parameters:

value - the actor

getFlowContext

adams.flow.core.Actor getFlowContext()

Returns the flow context, if any.

Specified by:

getFlowContext in interface adams.flow.core.FlowContextHandler

Returns:

the actor, null if none available

getQuickInfo

String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.
Default implementation returns null.

Specified by:

getQuickInfo in interface adams.core.QuickInfoSupporter

Returns:

null if no info available, otherwise short string

getRequiredPackages

String[] getRequiredPackages()

Returns the list of required LaTeX packages for this code generator.

Returns:

the packages

getAdditionalInformation

String getAdditionalInformation()

Returns the additional information.

Specified by:

getAdditionalInformation in interface adams.core.AdditionalInformationHandler

Returns:

the additional information, null or 0-length string for no information

generate

String generate()

Generates the code.

Returns:

the generated code