Package adams.doc.latex.generator

Class AbstractEnvironmentWithNoTrailingSpace

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.doc.latex.generator.AbstractCodeGenerator

adams.doc.latex.generator.AbstractEnvironmentWithNoTrailingSpace

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, EnvironmentWithNoTrailingSpace, adams.flow.core.FlowContextHandler, Serializable

Direct Known Subclasses:

Verbatim

public abstract class AbstractEnvironmentWithNoTrailingSpace
extends AbstractCodeGenerator
implements EnvironmentWithNoTrailingSpace

Ancestor for code generators that can suppress the trailing space.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_SuppressTrailingSpace	whether to suppress the trailing space or not.

Fields inherited from class adams.doc.latex.generator.AbstractCodeGenerator

m_FlowContext, m_NoVariableExpansion, m_Skip

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractEnvironmentWithNoTrailingSpace()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
boolean	getSuppressTrailingSpace()	Returns whether to suppress the trailing space.
void	setSuppressTrailingSpace(boolean value)	Sets whether to suppress the trailing space.
String	suppressTrailingSpaceTipText()	Returns the tip text for this property.

Methods inherited from class adams.doc.latex.generator.AbstractCodeGenerator

check, doGenerate, ensureTrailingNewLine, ensureTrailingNewLine, escape, expand, expandEscape, generate, getAdditionalInformation, getFlowContext, getNoVariableExpansion, getQuickInfo, getRequiredPackages, getSkip, noVariableExpansionTipText, setFlowContext, setNoVariableExpansion, setSkip, skipTipText

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.doc.latex.generator.CodeGenerator

generate, getAdditionalInformation, getFlowContext, getNoVariableExpansion, getQuickInfo, getRequiredPackages, getSkip, noVariableExpansionTipText, setFlowContext, setNoVariableExpansion, setSkip, skipTipText

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_SuppressTrailingSpace

protected boolean m_SuppressTrailingSpace

whether to suppress the trailing space or not.

Constructor Detail

AbstractEnvironmentWithNoTrailingSpace

public AbstractEnvironmentWithNoTrailingSpace()

Method Detail

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

setSuppressTrailingSpace

public void setSuppressTrailingSpace(boolean value)

Sets whether to suppress the trailing space.

Specified by:

setSuppressTrailingSpace in interface EnvironmentWithNoTrailingSpace

Parameters:

value - true if to suppress

getSuppressTrailingSpace

public boolean getSuppressTrailingSpace()

Returns whether to suppress the trailing space.

Specified by:

getSuppressTrailingSpace in interface EnvironmentWithNoTrailingSpace

Returns:

true if to suppress

suppressTrailingSpaceTipText

public String suppressTrailingSpaceTipText()

Returns the tip text for this property.

Specified by:

suppressTrailingSpaceTipText in interface EnvironmentWithNoTrailingSpace

Returns:

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