platypus
Class GDD

java.lang.Object
  platypus.GDD

public class GDD
extends java.lang.Object

GDD is the Global Document Data class. It contains several properties relating to the output document state, as well as to Platypus' state. Implemented using the Singleton pattern, as it is a one-time global item.

Author:

alb

See Also:

for a similar class for the input document (GID = Global Input Data)

Nested Class Summary

static class

GDD.FileType type of output file (such as PDF, HTML, etc).

Field Summary

private Alignment	alignment
private boolean	clVerbose
private boolean	clVVerbose
private Columns	columns
private int	currentColumn
private PlatyFont	currentFont
private PageFooter	footer
CommandId	gdd_command_ids
private Leading	leading
private Literals	lits instance of singleton that fetches the literals from the resource bundle
private java.util.logging.Logger	logger the only logger used in Platypus
private Margins	margin
private Value<java.lang.Boolean>	noIndent
private Outfile	outfile class containing all the output routines
private Counter	pageCounter
private PageSize	pageSize
private ParaIndent	paraIndent
private ParaSkip	paraSkip
private Strikethru	strikethru
private static GDD	thisInstance
private Underline	underline

Constructor Summary

private

GDD() private constructor used for singleton pattern.

Method Summary

void	dumpGDD() Dumps the GDD to stdout.
Alignment	getAlignment()
Columns	getColumns()
int	getCurrentColumn()
PlatyFont	getCurrFont()
PageFooter	getFooter()
static GDD	getInstance() The function used by singleton pattern to return handle to this class
Leading	getLeading()
java.util.logging.Logger	getLogger()
Margins	getMargin()
Value<java.lang.Boolean>	getNoIndent()
Outfile	getOutfile()
Counter	getPageCounter()
PageSize	getPageSize()
ParaIndent	getParaIndent()
ParaSkip	getParaSkip()
Strikethru	getStrikethru()
Underline	getUnderline()
void	initializeGDD() Initialize values.
boolean	isClVerbose()
boolean	isClVVerbose()
void	setAlignment(Alignment alignment)
void	setClVerbose(boolean clVerbose)
void	setClVVerbose(boolean clVVerbose)
void	setColumns(Columns columns)
void	setCurrentColumn(int currentColumn)
void	setCurrentFont(PlatyFont newFont)
void	setFooter(PageFooter footer)
void	setLeading(Leading leading)
void	setLogger(java.util.logging.Logger logger)
void	setMargin(Margins margin)
void	setNoIndent(Value<java.lang.Boolean> noIndent)
void	setOutfile(Outfile outfile)
void	setPageSize(PageSize pageSize)
void	setParaIndent(ParaIndent paraIndent)
void	setParaSkip(ParaSkip paraSkip)
void	setStrikethru(Strikethru strikethru)
void	setUnderline(Underline underline)
void	setupLogger() set up the logger we'll use and give it our own formatting.

Methods inherited from class java.lang.Object

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

Field Detail

lits

private final Literals lits

instance of singleton that fetches the literals from the resource bundle

outfile

private Outfile outfile

class containing all the output routines

gdd_command_ids

public CommandId gdd_command_ids

alignment

private Alignment alignment

columns

private Columns columns

currentColumn

private int currentColumn

currentFont

private PlatyFont currentFont

leading

private Leading leading

footer

private PageFooter footer

margin

private Margins margin

noIndent

private Value<java.lang.Boolean> noIndent

pageCounter

private Counter pageCounter

pageSize

private PageSize pageSize

paraIndent

private ParaIndent paraIndent

paraSkip

private ParaSkip paraSkip

strikethru

private Strikethru strikethru

underline

private Underline underline

clVerbose

private boolean clVerbose

clVVerbose

private boolean clVVerbose

logger

private java.util.logging.Logger logger

the only logger used in Platypus

thisInstance

private static final GDD thisInstance

Constructor Detail

GDD

private GDD()

private constructor used for singleton pattern. Initializes document properties to defaults.

Method Detail

initializeGDD

public void initializeGDD()

Initialize values. This is broken out separately due to possibility that we might want to chain jobs, so then re-initializing GDD will be necessary. Note: columns is initialized in OutfilePdf. It might eventually migrate there. logger is initialized in Platypus.

getInstance

public static GDD getInstance()

The function used by singleton pattern to return handle to this class

Returns:

handle to this instance of GDD class

dumpGDD

public void dumpGDD()

Dumps the GDD to stdout. Implements the [dump:all] command. TODO: add levels of dumping, so that different levels of detail can be shown

setupLogger

public void setupLogger()

set up the logger we'll use and give it our own formatting. This logger writes to the console only.

getCurrFont

public PlatyFont getCurrFont()

setCurrentFont

public void setCurrentFont(PlatyFont newFont)

getAlignment

public Alignment getAlignment()

setAlignment

public void setAlignment(Alignment alignment)

getColumns

public Columns getColumns()

setColumns

public void setColumns(Columns columns)

getCurrentColumn

public int getCurrentColumn()

setCurrentColumn

public void setCurrentColumn(int currentColumn)

getLeading

public Leading getLeading()

setLeading

public void setLeading(Leading leading)

getFooter

public PageFooter getFooter()

setFooter

public void setFooter(PageFooter footer)

getMargin

public Margins getMargin()

setMargin

public void setMargin(Margins margin)

getNoIndent

public Value<java.lang.Boolean> getNoIndent()

setNoIndent

public void setNoIndent(Value<java.lang.Boolean> noIndent)

getPageCounter

public Counter getPageCounter()

getPageSize

public PageSize getPageSize()

setPageSize

public void setPageSize(PageSize pageSize)

getParaIndent

public ParaIndent getParaIndent()

setParaIndent

public void setParaIndent(ParaIndent paraIndent)

getParaSkip

public ParaSkip getParaSkip()

setParaSkip

public void setParaSkip(ParaSkip paraSkip)

getStrikethru

public Strikethru getStrikethru()

setStrikethru

public void setStrikethru(Strikethru strikethru)

getUnderline

public Underline getUnderline()

setUnderline

public void setUnderline(Underline underline)

isClVerbose

public boolean isClVerbose()

setClVerbose

public void setClVerbose(boolean clVerbose)

isClVVerbose

public boolean isClVVerbose()

setClVVerbose

public void setClVVerbose(boolean clVVerbose)

getLogger

public java.util.logging.Logger getLogger()

setLogger

public void setLogger(java.util.logging.Logger logger)

getOutfile

public Outfile getOutfile()

setOutfile

public void setOutfile(Outfile outfile)