Package adams.doc.latex.generator

Class ClearPage

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.doc.latex.generator.AbstractCodeGenerator

adams.doc.latex.generator.ClearPage

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 ClearPage
extends AbstractCodeGenerator

Adds a '\clearpage' directive.

-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
 

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

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
ClearPage()

Method Summary

Modifier and Type	Method	Description
protected String	doGenerate()	Generates the actual code.
String[]	getRequiredPackages()	Returns the list of required LaTeX packages for this code generator.
String	globalInfo()	Returns a string describing the object.

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

check, defineOptions, 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

Methods inherited from class java.lang.Object

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

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

Constructor Detail

ClearPage

public ClearPage()

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

getRequiredPackages

public String[] getRequiredPackages()

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

Specified by:

getRequiredPackages in interface CodeGenerator

Specified by:

getRequiredPackages in class AbstractCodeGenerator

Returns:

the packages

doGenerate

protected String doGenerate()

Generates the actual code.

Specified by:

doGenerate in class AbstractCodeGenerator

Returns:

the generated code