Package adams.doc.latex.generator

Class NewSection

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.doc.latex.generator.AbstractCodeGenerator

adams.doc.latex.generator.NewSection

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

Adds a new section to the document with an optional label for cross-referencing.

-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
 

-page-action <NONE|NEWPAGE|CLEARPAGE> (property: pageAction)
    The page action to insert.
    default: NONE
 

-type <PART|CHAPTER|SECTION|SUBSECTION|SUBSUBSECTION|PARAGRAPH|SUBPARAGRAPH> (property: type)
    The type of the section.
    default: SECTION
 

-title <java.lang.String> (property: title)
    The title of the section.
    default: 
 

-label <java.lang.String> (property: label)
    The optional label of the section (for cross-referencing).
    default: 
 

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NewSection.PageAction	The page action.
static class	NewSection.SectionType	The types of sections.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_Label	the (optional) label for the section.
protected NewSection.PageAction	m_PageAction	the page action.
protected String	m_Title	the title of the section.
protected NewSection.SectionType	m_Type	the type of section.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected String	doGenerate()	Generates the actual code.
String	getLabel()	Returns the label.
NewSection.PageAction	getPageAction()	Returns the page action.
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.
String	getTitle()	Returns the title.
NewSection.SectionType	getType()	Returns the type.
String	globalInfo()	Returns a string describing the object.
String	labelTipText()	Returns the tip text for this property.
String	pageActionTipText()	Returns the tip text for this property.
void	setLabel(String value)	Sets the label.
void	setPageAction(NewSection.PageAction value)	Sets the page action.
void	setTitle(String value)	Sets the title.
void	setType(NewSection.SectionType value)	Sets the type.
String	titleTipText()	Returns the tip text for this property.
String	typeTipText()	Returns the tip text for this property.

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

check, ensureTrailingNewLine, ensureTrailingNewLine, escape, expand, expandEscape, generate, getAdditionalInformation, getFlowContext, getNoVariableExpansion, 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

Field Detail

m_PageAction

protected NewSection.PageAction m_PageAction

the page action.

m_Type

protected NewSection.SectionType m_Type

the type of section.

m_Title

protected String m_Title

the title of the section.

m_Label

protected String m_Label

the (optional) label for the section.

Constructor Detail

NewSection

public NewSection()

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

setPageAction

public void setPageAction(NewSection.PageAction value)

Sets the page action.

Parameters:

value - the action

getPageAction

public NewSection.PageAction getPageAction()

Returns the page action.

Returns:

the action

pageActionTipText

public String pageActionTipText()

Returns the tip text for this property.

Returns:

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

setType

public void setType(NewSection.SectionType value)

Sets the type.

Parameters:

value - the type

getType

public NewSection.SectionType getType()

Returns the type.

Returns:

the type

typeTipText

public String typeTipText()

Returns the tip text for this property.

Returns:

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

setTitle

public void setTitle(String value)

Sets the title.

Parameters:

value - the title

getTitle

public String getTitle()

Returns the title.

Returns:

the title

titleTipText

public String titleTipText()

Returns the tip text for this property.

Returns:

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

setLabel

public void setLabel(String value)

Sets the label.

Parameters:

value - the label

getLabel

public String getLabel()

Returns the label.

Returns:

the label

labelTipText

public String labelTipText()

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:

getRequiredPackages in interface CodeGenerator

Specified by:

getRequiredPackages in class AbstractCodeGenerator

Returns:

the packages

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

doGenerate

protected String doGenerate()

Generates the actual code.

Specified by:

doGenerate in class AbstractCodeGenerator

Returns:

the generated code