Platypus
A B C D E F G H I L M N O P R S T U V W

A

A_ACUTE - Static variable in class platypus.TokTyp
 
A_BREVE - Static variable in class platypus.TokTyp
 
A_CAP_ACUTE - Static variable in class platypus.TokTyp
 
A_CAP_BREVE - Static variable in class platypus.TokTyp
 
A_CAP_CARON - Static variable in class platypus.TokTyp
 
A_CAP_CIRCLE - Static variable in class platypus.TokTyp
 
A_CAP_CIRCUMFLEX - Static variable in class platypus.TokTyp
 
A_CAP_GRAVE - Static variable in class platypus.TokTyp
 
A_CAP_MACRON - Static variable in class platypus.TokTyp
 
A_CAP_TILDE - Static variable in class platypus.TokTyp
 
A_CAP_UMLAUT - Static variable in class platypus.TokTyp
 
A_CARON - Static variable in class platypus.TokTyp
 
A_CIRCLE - Static variable in class platypus.TokTyp
 
A_CIRCUMFLEX - Static variable in class platypus.TokTyp
 
A_GRAVE - Static variable in class platypus.TokTyp
 
A_MACRON - Static variable in class platypus.TokTyp
 
A_TILDE - Static variable in class platypus.TokTyp
 
A_UMLAUT - Static variable in class platypus.TokTyp
 
add(String, String) - Method in class platypus.UserString
Add a macro to the table of user strings
addParagraph() - Method in class platypus.Outfile
Adds paragraph to document.
addToken(Token, int) - Method in class platypus.Tokens
Add a token to the Tokens array
adjustStrikethru() - Method in class platypus.PlatyFont
when the size of a font changes, the place where the strikethru line appears should change, so that on a relative basis it crosses through the same part of each character, regardless of the height of the character.
ALIGN_CENTER - Static variable in class platypus.PlatyConst
 
ALIGN_JUSTIFIED - Static variable in class platypus.PlatyConst
 
ALIGN_LEFT - Static variable in class platypus.PlatyConst
 
ALIGN_RIGHT - Static variable in class platypus.PlatyConst
 
alignment() - Static method in class platypus.DumpValue
Creates a string containing the line # and the value of the bottom margin when last set
ALIGNMENT - Static variable in class platypus.TokTyp
 
amount - Variable in class platypus.CommandValue
amount in units
amount - Variable in class platypus.pdf.Leading
 
AT_EOF - Static variable in class platypus.Status
 

B

bold - Variable in class platypus.PlatyFont
is font bold?
BOLD_OFF - Static variable in class platypus.TokTyp
 
BOLD_ON - Static variable in class platypus.TokTyp
 
BOTTOM_MARGIN - Static variable in class platypus.TokTyp
 
bottomMargin() - Static method in class platypus.DumpValue
Creates a string containing the line # and the value of the bottom margin when last set

C

C_CAP_CEDILLA - Static variable in class platypus.TokTyp
 
C_CEDILLA - Static variable in class platypus.TokTyp
 
close() - Method in class platypus.Outfile
iText-required function at end of processing.
clVerbose - Variable in class platypus.GDD
 
clVVerbose - Variable in class platypus.GDD
 
CMS - Static variable in class platypus.PlatyConst
 
CMS_PER_INCH - Static variable in class platypus.PlatyConst
one inch = 2.54 centimeters
cmsToPoints(float) - Static method in class platypus.PlatyConst
 
cmsToPoints(int) - Static method in class platypus.PlatyConst
 
Command - Class in platypus
Converts command strings into actions.
Command() - Constructor for class platypus.Command
get the instances of the singletons we use here.
COMMAND - Static variable in class platypus.TokTyp
 
CommandId - Class in platypus
All supported commands are placed in a tree, where each node consists of the command string and a command identifier, which will be used to call the right routine.
CommandId() - Constructor for class platypus.CommandId
 
commands - Variable in class platypus.CommandId
a tree consisting of the command lexemes and the associated token types
CommandValue - Class in platypus
Class for processing commands with numeric parameters.
CommandValue() - Constructor for class platypus.CommandValue
Creates a generic CommandValue and sets it to default values
CommandValue(float) - Constructor for class platypus.CommandValue
Creates a CommandValue and sets it to inAmount.
CommandValue(String, String) - Constructor for class platypus.CommandValue
Constructor that is passed a value+unit substring and creates a CommandValue object containing fields for value and units.
commentLines - Variable in class platypus.Infile
used only for unit testing purposes
composeEndOfComment(int, String) - Method in class platypus.Infile
Accepts a line of text and an index of the first character of an opening comment block.
content - Variable in class platypus.Token
 
convertUnitsToPoints() - Method in class platypus.UnitValue
converts type and value to points
COPYRIGHT - Static variable in class platypus.TokTyp
 
currLine - Variable in class platypus.GID
 
currLineNumber - Variable in class platypus.Infile
the line number in the original input file (from ReadLine)

D

DEFAULT_FONT_SIZE_PTS - Static variable in class platypus.PlatyConst
 
DEFAULT_FOOTER_FONT_SIZE_PTS - Static variable in class platypus.PlatyConst
 
DEFAULT_FOOTER_PAGES_TO_SKIP - Static variable in class platypus.PlatyConst
 
DEFAULT_FOOTER_TYPEFACE - Static variable in class platypus.PlatyConst
 
DEFAULT_LEADING_PTS - Static variable in class platypus.PlatyConst
 
DEFAULT_MARGIN_PTS - Static variable in class platypus.PlatyConst
 
DEFAULT_PAGE_HT_PTS - Static variable in class platypus.PlatyConst
 
DEFAULT_PAGE_WD_PTS - Static variable in class platypus.PlatyConst
 
DEFAULT_PARA_INDENT_PTS - Static variable in class platypus.PlatyConst
 
DEFAULT_STRIKETRHU_LINE_WIDTH - Static variable in class platypus.PlatyConst
 
DEFAULT_TYPEFACE - Static variable in class platypus.PlatyConst
 
DEFAULT_UNDERLINE_LOCATION - Static variable in class platypus.PlatyConst
 
DEFAULT_UNDERLINE_THICKNESS - Static variable in class platypus.PlatyConst
 
DEFINE_MACRO - Static variable in class platypus.TokTyp
 
dispatchCommand(int, String) - Method in class platypus.Command
Calls the routine that performs the command based on commandType
doAlignment(String) - Method in class platypus.Command
Processes the alignment command by setting gdd_alignment to the specified value.
DOCUMENT_CLOSED_ERR - Static variable in class platypus.Status
 
doDefineMacro(String) - Method in class platypus.Command
Defines a string to place in the macro dictionary
doDump(String) - Method in class platypus.Command
Dumps various groups of variables to console.
doDumpPage() - Method in class platypus.Command
Dump the various elements of a page in Platypus to the console.
doesExist() - Method in class platypus.Infile
Verifies the existence of a specific file.
doFontBold(boolean) - Method in class platypus.Command
Turn the bold attribute of a font on or off.
doFontFace(String) - Method in class platypus.Command
Changes the current font to a new typeface.
doFontItalic(boolean) - Method in class platypus.Command
Turn the italic attribute of the current font on or off
doFontSize(String) - Method in class platypus.Command
Changes the current font to a different size
doLeading(String) - Method in class platypus.Command
set the leading based on a user-supplied value (and type); e.g., 2li, 0.5in, etc.
doMargin(int, String) - Method in class platypus.Command
handles setting the page margins.
doMarginMirror(boolean) - Method in class platypus.Command
Sets the margin-mirror flag.
doNewPage() - Method in class platypus.Command
Inserts a new page.
doNewParagraph() - Method in class platypus.Command
Insert a new paragraph.
doPageHeight(String) - Method in class platypus.Command
Page size is generally specified using a preset page size.
doPageSize(String) - Method in class platypus.Command
Change the size of the page.
doPageWidth(String) - Method in class platypus.Command
Page size is generally specified using a preset page size.
doParagraphIndent(String) - Method in class platypus.Command
Creates a new ParaIndent (paragraph indent) structure and assigns it to the one in GDD provide no error occurred.
doParagraphSkipSize(String) - Method in class platypus.Command
Creates a new ParaSkip (paragraph line skip) structure, loads it with the values in the command and places it in GDD, provided no error occurred.
doPrintMacro(String) - Method in class platypus.Command
Look up the macro and in the table and output the substitute string into text
doStrikethru(boolean) - Method in class platypus.Command
Turn strikethrough on or off.
doUnderline(boolean) - Method in class platypus.Command
Turn underline on or off.
dump() - Method in class platypus.CommandValue
Dumps content of data items in user-friendly format.
dump() - Method in class platypus.pdf.Leading
Creates a string containing the line # and the value of the bottom margin when last set
dump() - Method in class platypus.pdf.PageSize
Creates a string containing the line # and the values of page size when last set
dump() - Method in class platypus.pdf.ParaIndent
 
dump() - Method in class platypus.pdf.ParaSkip
Creates a string containing the line # and the value for the height of the strikethrough line when last set
dump() - Method in class platypus.pdf.Strikethru
Creates a string containing the line # and the value for the height of the strikethrough line when last set
dump() - Method in class platypus.pdf.Underline
 
DUMP - Static variable in class platypus.TokTyp
 
dump() - Method in class platypus.Value
Creates a partial string containing the dump information for the value.
dumpGDD() - Method in class platypus.GDD
Dumps the GDD to stdout.
dumpPlatypusStrings() - Method in class platypus.UserString
Dump all the strings defined by Platypus in the table to one long string.
dumpUserStrings() - Method in class platypus.UserString
Dump all the user-defined string to one long string.
DumpValue - Class in platypus
Series of static functions that dump a value to a string, so that it can be printed by the various [dump:..] commands
DumpValue() - Constructor for class platypus.DumpValue
 

E

E_ACUTE - Static variable in class platypus.TokTyp
 
E_BREVE - Static variable in class platypus.TokTyp
 
E_CAP_ACUTE - Static variable in class platypus.TokTyp
 
E_CAP_BREVE - Static variable in class platypus.TokTyp
 
E_CAP_CARON - Static variable in class platypus.TokTyp
 
E_CAP_CIRCLE - Static variable in class platypus.TokTyp
 
E_CAP_CIRCUMFLEX - Static variable in class platypus.TokTyp
 
E_CAP_GRAVE - Static variable in class platypus.TokTyp
 
E_CAP_MACRON - Static variable in class platypus.TokTyp
 
E_CAP_TILDE - Static variable in class platypus.TokTyp
 
E_CAP_UMLAUT - Static variable in class platypus.TokTyp
 
E_CARON - Static variable in class platypus.TokTyp
 
E_CIRCLE - Static variable in class platypus.TokTyp
 
E_CIRCUMFLEX - Static variable in class platypus.TokTyp
 
E_GRAVE - Static variable in class platypus.TokTyp
 
E_MACRON - Static variable in class platypus.TokTyp
 
E_TILDE - Static variable in class platypus.TokTyp
 
E_UMLAUT - Static variable in class platypus.TokTyp
 
emitText(String) - Method in class platypus.Outfile
Two actions can result from an item in an input file: it can set the value of a variable (such as margins, for example) or result in text that must be emitted to the output file stream.
EOF - Static variable in class platypus.TokTyp
 
ERR - Static variable in class platypus.Status
 
ERROR - Static variable in class platypus.PlatyConst
 

F

FATAL_ERR - Static variable in class platypus.Status
 
FILE_NOT_FOUND_ERR - Static variable in class platypus.Status
 
FILE_NOT_READABLE_ERR - Static variable in class platypus.Status
 
filename - Variable in class platypus.Infile
the name of the input file
font - Variable in class platypus.PlatyFont
an iText font data item
FONT_FACE - Static variable in class platypus.TokTyp
 
FONT_SIZE - Static variable in class platypus.TokTyp
 
FONT_SIZE_TO_STRIKETHRU_RATIO - Static variable in class platypus.PlatyConst
unless otherwise stated, strikethrough location is 1/4 of font size above the baseline
FontSize - Class in platypus
Handles the command specifying the size of a font.
FontSize(String, String) - Constructor for class platypus.FontSize
 
FontSize(float) - Constructor for class platypus.FontSize
 
footer - Variable in class platypus.GDD
 
footerFont - Variable in class platypus.pdf.PageFooter
 
format(LogRecord) - Method in class platypus.LogFormatter
The principal function: it accepts a LogRecord and returns the string that should be written out by the logger.
FTO_doStrikethru(boolean) - Method in class platypus.Command
FTO = for testing only.
FTO_getUnitType(String, int) - Method in class platypus.UnitValue
FTO prefix = for testing only.
FTOgetCommandCount() - Method in class platypus.CommandId
Returns the number of commands in the command tree.
FTOgetCommands() - Method in class platypus.CommandId
For testing only (FTO).
FTOsetCurr(ReadLine) - Method in class platypus.GID
This function is FTO because and not used in production code because GID only has the one currLine.
FTOsetDocument(Document) - Method in class platypus.Outfile
 

G

gdd - Variable in class platypus.Command
instance of the GDD singleton
GDD - Class in platypus
GDD is the Global Document Data class.
GDD() - Constructor for class platypus.GDD
private constructor used for singleton pattern.
gdd - Variable in class platypus.Infile
 
gdd - Variable in class platypus.Outfile
 
gdd - Static variable in class platypus.Platypus
GDD: global document data: all data re the output file at any given point (singleton)
gdd - Variable in class platypus.Tokens
 
GDD.FileType - Enum in platypus
kind of output file (such as PDF, HTML, etc).
GDD.FileType() - Constructor for enum platypus.GDD.FileType
 
GDD.ValueBool - Class in platypus
 
GDD.ValueBool(boolean) - Constructor for class platypus.GDD.ValueBool
 
gdd_alignment - Variable in class platypus.GDD
 
gdd_bottom_margin - Variable in class platypus.GDD
 
gdd_command_ids - Variable in class platypus.GDD
 
gdd_curr_font - Variable in class platypus.GDD
 
gdd_curr_font_size - Variable in class platypus.GDD
 
gdd_left_margin - Variable in class platypus.GDD
 
gdd_margins_mirrored - Variable in class platypus.GDD
 
gdd_no_indent - Variable in class platypus.GDD
 
gdd_right_margin - Variable in class platypus.GDD
 
gdd_top_margin - Variable in class platypus.GDD
 
get(String) - Method in class platypus.CommandId
Returns the type of the command based on looking up the command lexeme
get(String) - Method in class platypus.UserString
Retrieve a string based on its key (the macro name)
getAlignment() - Method in class platypus.GDD
 
getAlignmentLine() - Method in class platypus.GDD
 
getAmount() - Method in class platypus.CommandValue
return the amount of units
getAmount() - Method in class platypus.pdf.Leading
 
getBottomMargin() - Method in class platypus.GDD
 
getBottomMarginLine() - Method in class platypus.GDD
 
getContent() - Method in class platypus.Token
return the content portion of the token (a String)
getCurrFont() - Method in class platypus.GDD
 
getCurrFontSize() - Method in class platypus.GDD
 
getCurrLine() - Method in class platypus.GID
Returns the current line
getFilename() - Method in class platypus.Infile
 
getFont() - Method in class platypus.PlatyFont
return the core font element in PlatyFont
getHeight() - Method in class platypus.pdf.PageSize
getter for page height
getInfile() - Method in class platypus.GID
 
getInstance() - Static method in class platypus.GDD
The function used by singleton pattern to return handle to this class
getInstance() - Static method in class platypus.GID
The function used by singleton pattern to return handle to this class
getInstance() - Static method in class platypus.Literals
 
getLeftMargin() - Method in class platypus.GDD
 
getLeftMarginLine() - Method in class platypus.GDD
 
getLength() - Method in class platypus.UnitValue
 
getLine() - Method in class platypus.Infile
Gets the next line in the ArrayList of parsed lines from the input file.
getLine() - Method in class platypus.Value
Returns an integer containing the line number of when the value was last modified
getLineContent() - Method in class platypus.ReadLine
return a string with the line content
getLineCount() - Method in class platypus.Infile
used primarily (exclusively?) in unit tests
getLineNumber() - Method in class platypus.CommandValue
return the line number where the command was found
getLineNumber() - Method in class platypus.GDD
convenience function that requires less typing to get the line number from GID
getLineNumber() - Method in class platypus.Infile
returns the current line number being handled by Infile
getLineNumber() - Method in class platypus.pdf.Leading
 
getLineNumber() - Method in class platypus.pdf.Underline
 
getLineNumber() - Method in class platypus.PlatyFont
 
getLineNumber() - Method in class platypus.ReadLine
return the line number we're currently working on
getLit(String) - Method in class platypus.Literals
Looks up a literal in the resource bundle.
getLocation() - Method in class platypus.pdf.Underline
 
getMirrorMargin() - Method in class platypus.GDD
 
getNoIndent() - Method in class platypus.GDD
 
getOutFilename() - Method in class platypus.GDD
 
getOutFileType() - Method in class platypus.GDD
 
getPagesToSkip() - Method in class platypus.pdf.PageFooter
 
getPagesToSkipLineSet() - Method in class platypus.pdf.PageFooter
Get the line # where the pages to skip was set.
getPlatyFont() - Method in class platypus.pdf.PageFooter
 
getRightMargin() - Method in class platypus.GDD
 
getRightMarginLine() - Method in class platypus.GDD
 
getSize() - Method in class platypus.PlatyFont
 
getStatus() - Method in class platypus.OutputSpecialChar
return the status of the constructor.
getTextLines() - Method in class platypus.Infile
 
getTokens() - Method in class platypus.GID
 
getToks() - Method in class platypus.Tokens
 
getTopMargin() - Method in class platypus.GDD
 
getTopMarginLine() - Method in class platypus.GDD
 
getType() - Method in class platypus.Token
return the type of token
getType() - Method in class platypus.UnitValue
 
getTypeface() - Method in class platypus.PlatyFont
 
getUnits() - Method in class platypus.CommandValue
return the number of units
getUnitType(String, int) - Method in class platypus.UnitValue
Figures out whether s[i..i+1] is a unit of measure
getValue() - Method in class platypus.UnitValue
 
getValue() - Method in class platypus.Value
In a parameterized class, this returns an Object even if declared as A getValue(), so return a string and convert it at point of use via Float.valueOf or Integer.valueOf().
getWidth() - Method in class platypus.pdf.PageSize
getter for page width
gid - Variable in class platypus.Command
instance of the GID singleton
GID - Class in platypus
GID is the Global Input-file Data class.
GID() - Constructor for class platypus.GID
 
gid - Variable in class platypus.Infile
 
gid - Static variable in class platypus.Platypus
GID: global input data: all data re the input file at any given moment (singleton)
gid - Variable in class platypus.Tokens
 

H

hasTextBeenProcessed() - Method in class platypus.GDD
 
height - Variable in class platypus.pdf.PageSize
page height in points

I

I_ACUTE - Static variable in class platypus.TokTyp
 
I_BREVE - Static variable in class platypus.TokTyp
 
I_CAP_ACUTE - Static variable in class platypus.TokTyp
 
I_CAP_BREVE - Static variable in class platypus.TokTyp
 
I_CAP_CARON - Static variable in class platypus.TokTyp
 
I_CAP_CIRCLE - Static variable in class platypus.TokTyp
 
I_CAP_CIRCUMFLEX - Static variable in class platypus.TokTyp
 
I_CAP_GRAVE - Static variable in class platypus.TokTyp
 
I_CAP_MACRON - Static variable in class platypus.TokTyp
 
I_CAP_TILDE - Static variable in class platypus.TokTyp
 
I_CAP_UMLAUT - Static variable in class platypus.TokTyp
 
I_CARON - Static variable in class platypus.TokTyp
 
I_CIRCLE - Static variable in class platypus.TokTyp
 
I_CIRCUMFLEX - Static variable in class platypus.TokTyp
 
I_GRAVE - Static variable in class platypus.TokTyp
 
I_MACRON - Static variable in class platypus.TokTyp
 
I_TILDE - Static variable in class platypus.TokTyp
 
I_UMLAUT - Static variable in class platypus.TokTyp
 
ILLEGAL_OP - Static variable in class platypus.Status
 
INCHES - Static variable in class platypus.PlatyConst
 
inchesToPoints(float) - Static method in class platypus.PlatyConst
 
inchesToPoints(int) - Static method in class platypus.PlatyConst
 
incrementLineCount() - Method in class platypus.Infile
convenience function for incrementing the pointer to the next line in the input stream
indentParagraphFirstLine(float) - Method in class platypus.Outfile
Indent the first line of the paragraph by indentPoints This code requires explanation.
inEffect - Variable in class platypus.pdf.Underline
is underlining in effect currently?
infile - Variable in class platypus.GID
 
Infile - Class in platypus
Handles input file I/O functions.
Infile(String) - Constructor for class platypus.Infile
 
initialize() - Method in class platypus.GID
mostly used in testing to put GID back into a known state.
initialize(String) - Method in class platypus.pdf.PageSize
Initialize the page size to one of the pre-written shorthand sizes (LTR, LGL, A4, etc.)
initializeGDD() - Method in class platypus.GDD
Initialize values.
INVALID_COMMAND - Static variable in class platypus.TokTyp
 
INVALID_DATA - Static variable in class platypus.Status
 
INVALID_PARAM - Static variable in class platypus.Status
 
INVALID_PARAM_NULL - Static variable in class platypus.Status
 
INVALID_TOKEN - Static variable in class platypus.Status
 
INVERTED_EXCLAM - Static variable in class platypus.TokTyp
 
INVERTED_QUESTION - Static variable in class platypus.TokTyp
 
IO_ERR - Static variable in class platypus.Status
 
isActive() - Method in class platypus.pdf.Strikethru
 
isBold() - Method in class platypus.PlatyFont
 
isInEffect() - Method in class platypus.pdf.Underline
 
isItalic() - Method in class platypus.PlatyFont
 
isLeadingChanged() - Method in class platypus.pdf.Leading
 
isOutFileOpen() - Method in class platypus.GDD
 
isReadable() - Method in class platypus.Infile
Verifies that the file can be read.
isUpper(Character) - Method in class platypus.UserString
Java has no simple way of doing this, alas.
italic - Variable in class platypus.PlatyFont
is font italic/slanted?
ITALICS_OFF - Static variable in class platypus.TokTyp
 
ITALICS_ON - Static variable in class platypus.TokTyp
 
iTDocument - Variable in class platypus.Outfile
 
iTPara - Variable in class platypus.Outfile
 
iTWriter - Variable in class platypus.Outfile
 

L

leading - Variable in class platypus.GDD
 
Leading - Class in platypus.pdf
Handles the leading for text.
Leading() - Constructor for class platypus.pdf.Leading
 
LEADING - Static variable in class platypus.TokTyp
 
LEADING_TO_FONT_RATIO - Static variable in class platypus.PlatyConst
 
leadingChanged - Variable in class platypus.pdf.Leading
 
LEFT_MARGIN - Static variable in class platypus.TokTyp
 
leftMargin() - Static method in class platypus.DumpValue
Creates a string containing the line # and the value of the left margin when last set
length - Variable in class platypus.UnitValue
 
line - Variable in class platypus.pdf.Leading
 
LINE_NUMBER - Static variable in class platypus.TokTyp
 
lineContent - Variable in class platypus.ReadLine
 
lineNum - Variable in class platypus.GDD.ValueBool
 
lineNumber - Variable in class platypus.CommandValue
the line number in the input text where this was value was set/used
lineNumber - Variable in class platypus.pdf.PageSize
line where page size is specified
lineNumber - Variable in class platypus.pdf.Underline
line number where the value of Underline was last changed
lineNumber - Variable in class platypus.PlatyFont
line number in the input file at which this font was specified
lineNumber - Variable in class platypus.ReadLine
 
lineNumber - Variable in class platypus.Value
 
LINES - Static variable in class platypus.PlatyConst
 
linesToPoints(float) - Static method in class platypus.PlatyConst
Converts lines to points.
linesToPoints(int) - Static method in class platypus.PlatyConst
 
Literals - Class in platypus
Handles getting literal strings from resource bundle.
Literals(String) - Constructor for class platypus.Literals
Open a resource bundle with the name: resourceName.properties In the event the resource bundle cannot be found, the program shuts down.
lits - Variable in class platypus.Command
instance of the Literals singleton
lits - Variable in class platypus.GDD
instance of singleton that fetches the literals from the resource bundle
lits - Variable in class platypus.Literals
 
lits - Variable in class platypus.LogFormatter
convenience variable for Literals access
lits - Variable in class platypus.Outfile
 
lits - Static variable in class platypus.Platypus
resource bundle that holds all the literals used in Platypus (singleton)
lits - Variable in class platypus.Tokens
 
loadCommands() - Method in class platypus.CommandId
Loads all the supported commands into the CommandID tree.
loadPageNames() - Method in class platypus.pdf.PageSize
Load the page names and the corresponding iText rectangles into a hash table.
location - Variable in class platypus.pdf.Underline
the location of underline relative to the baseline.
LogFormatter - Class in platypus
Creates a formatter for logging records.
LogFormatter() - Constructor for class platypus.LogFormatter
 
logger - Variable in class platypus.GDD
the only logger used in Platypus

M

macros - Static variable in class platypus.Platypus
user-defined strings, numerics, and macros
main(String[]) - Static method in class platypus.Platypus
This mainline: 1) Sets up the major data structures 2) Emits the copyright notice.
mainProcessing(String) - Static method in class platypus.Platypus
The main processing routine.
Margin - Class in platypus
Handles the command specifying the amount of in the page margins.
Margin(String, String) - Constructor for class platypus.Margin
 
Margin(float) - Constructor for class platypus.Margin
 
MARGIN_MIRROR - Static variable in class platypus.TokTyp
 
MIN_TOKEN_LEN - Static variable in class platypus.PlatyConst
must be at least two characters in a token
MINIMUM_FONT_SIZE - Static variable in class platypus.PlatyConst
 
MISSING_PARAM - Static variable in class platypus.Status
 
MISSING_TOKEN - Static variable in class platypus.Status
 
MMS_PER_CM - Static variable in class platypus.PlatyConst
one cm = 10mm

N

N_CAP_TILDE - Static variable in class platypus.TokTyp
 
N_TILDE - Static variable in class platypus.TokTyp
 
NEW_PAGE - Static variable in class platypus.TokTyp
 
NEW_PARAGRAPH - Static variable in class platypus.TokTyp
 
newPage() - Method in class platypus.Outfile
Creates a new page in the document.
newParagraph() - Method in class platypus.Outfile
convenience function for creating a new paragraph
NO_ERROR - Static variable in class platypus.Status
 
NO_INDENT - Static variable in class platypus.TokTyp
 
NOT_SPECIFIED - Static variable in class platypus.PlatyConst
 

O

O_ACUTE - Static variable in class platypus.TokTyp
 
O_BREVE - Static variable in class platypus.TokTyp
 
O_CAP_ACUTE - Static variable in class platypus.TokTyp
 
O_CAP_BREVE - Static variable in class platypus.TokTyp
 
O_CAP_CARON - Static variable in class platypus.TokTyp
 
O_CAP_CIRCLE - Static variable in class platypus.TokTyp
 
O_CAP_CIRCUMFLEX - Static variable in class platypus.TokTyp
 
O_CAP_GRAVE - Static variable in class platypus.TokTyp
 
O_CAP_MACRON - Static variable in class platypus.TokTyp
 
O_CAP_TILDE - Static variable in class platypus.TokTyp
 
O_CAP_UMLAUT - Static variable in class platypus.TokTyp
 
O_CARON - Static variable in class platypus.TokTyp
 
O_CIRCLE - Static variable in class platypus.TokTyp
 
O_CIRCUMFLEX - Static variable in class platypus.TokTyp
 
O_GRAVE - Static variable in class platypus.TokTyp
 
O_MACRON - Static variable in class platypus.TokTyp
 
O_TILDE - Static variable in class platypus.TokTyp
 
O_UMLAUT - Static variable in class platypus.TokTyp
 
OFF - Static variable in class platypus.Status
 
OK - Static variable in class platypus.Status
 
ON - Static variable in class platypus.Status
 
onEndPage(PdfWriter, Document) - Method in class platypus.pdf.PageFooter
Print the footer consisting of em-dash + page number + em-dash if we have skipped a sufficient number of pages without a footer.
OP_NOT_PERMITTED - Static variable in class platypus.Status
 
open() - Method in class platypus.Outfile
creates and opens iText document into which we write the ouput
outfile - Variable in class platypus.GDD
 
Outfile - Class in platypus
Handles document creation/termination and command routines in iText library
Outfile() - Constructor for class platypus.Outfile
 
outFileIsOpen - Variable in class platypus.GDD
 
outFilename - Variable in class platypus.GDD
 
outFileType - Variable in class platypus.GDD
 
OutputSpecialChar - Class in platypus
Emits all special characters.
OutputSpecialChar(int) - Constructor for class platypus.OutputSpecialChar
 

P

PAGE_ADDED - Static variable in class platypus.Status
 
PAGE_HEIGHT - Static variable in class platypus.TokTyp
 
PAGE_NOT_ADDED - Static variable in class platypus.Status
 
PAGE_SIZE - Static variable in class platypus.TokTyp
 
PAGE_WIDTH - Static variable in class platypus.TokTyp
 
PageFooter - Class in platypus.pdf
Places the page number as a footer on the bottom of each page (to the right) Once it's working, it will be converted into a command.
PageFooter() - Constructor for class platypus.pdf.PageFooter
Set the font, font size, and the number of pages to skip before the footer is first printed.
pageNames - Variable in class platypus.pdf.PageSize
HashMap that maps strings of page-size names to iText rectangles
pageSize - Variable in class platypus.GDD
 
PageSize - Class in platypus.pdf
All functions relating to setting, getting, and dumping the page size
PageSize() - Constructor for class platypus.pdf.PageSize
Default constructor simply uses the default values (letter, or 8.5" x 11")
pagesToSkip - Variable in class platypus.pdf.PageFooter
 
PARA_INDENT_1 - Static variable in class platypus.TokTyp
 
PARA_SKIP - Static variable in class platypus.TokTyp
 
paraIndent - Variable in class platypus.GDD
 
ParaIndent - Class in platypus.pdf
Processes the indent of the first line of a paragraph
ParaIndent(String, String) - Constructor for class platypus.pdf.ParaIndent
 
ParaIndent(float) - Constructor for class platypus.pdf.ParaIndent
 
paraSkip - Variable in class platypus.GDD
 
ParaSkip - Class in platypus.pdf
Handles the command specifying the amount of space (generally, the number of lines) to skip before the beginning of a new paragraph.
ParaSkip(String, String) - Constructor for class platypus.pdf.ParaSkip
 
ParaSkip(float) - Constructor for class platypus.pdf.ParaSkip
 
parse() - Method in class platypus.ReadLine
Parses gid.currLine into a tokens[].
parse(ReadLine) - Method in class platypus.ReadLine
Parses the readline into an array of tokens.
PlatyConst - Class in platypus
Immutable constants used in Platypus (Does not include status and error codes, which are located in Status.java)
PlatyConst() - Constructor for class platypus.PlatyConst
 
PlatyFont - Class in platypus
PlatyFont contains font information that can be used in Platypus It's not called Font, due to naming conflict with iText.
PlatyFont() - Constructor for class platypus.PlatyFont
set up PlatyFont.
PlatyFont(String) - Constructor for class platypus.PlatyFont
set up PlatyFont.
PlatyFont(float) - Constructor for class platypus.PlatyFont
set up PlatyFont, using the current font but changing its size
PlatyFont(String, float) - Constructor for class platypus.PlatyFont
set up PlatyFont using the specified font name and font size
PlatyFont(boolean, String, float) - Constructor for class platypus.PlatyFont
If pure, then set up a de minimus font with all ornaments turned off
platypus - package platypus
 
Platypus - Class in platypus
Main module for Platypus
Platypus() - Constructor for class platypus.Platypus
Creates the global data blocks, gets the literals resource bundle, sets up our default logger, and finally creates the data structures for an output file.
platypus.pdf - package platypus.pdf
 
PlatyVersion - Class in platypus
Contains the Platypus version number (a four-way dotted version counter).
PlatyVersion() - Constructor for class platypus.PlatyVersion
 
POINTS - Static variable in class platypus.PlatyConst
 
POINTS_PER_INCH - Static variable in class platypus.PlatyConst
one inch = 72 points
pointsFormatted(float) - Static method in class platypus.DumpValue
Format a floating-point value to a string with at most 1 decimal point
pointsToInches(float) - Static method in class platypus.DumpValue
returns a string with text of points converted to inches with corresponding text
PRINT_MACRO - Static variable in class platypus.TokTyp
 
process(char[]) - Method in class platypus.Command
The main switch that identifies the commands and dispatches them to the correct routine
process() - Method in class platypus.Tokens
Process the tokens in the array gid.tokens at a basic level: line number, text, and commands are all dispatched to the routines that process them further.
processCommandLine(String[]) - Static method in class platypus.Platypus
Processes the command line.
processCommandLineSwitches(String[]) - Static method in class platypus.Platypus
processes all the items on the command line, other than the filenames of the input and output files.
processInputFile() - Static method in class platypus.Platypus
the main routine that processes the input file
processor - Variable in class platypus.Outfile
 
processPsizeClSwitch(String[], int) - Static method in class platypus.Platypus
Process the -psize command-line switch ( = page size )
processVerboseClSwitch() - Static method in class platypus.Platypus
Process the -verbose command-line switch ( = verbose output )
processVVerboseClSwitch() - Static method in class platypus.Platypus
Process the -vverbose command-line switch ( = very verbose output )

R

readFile() - Method in class platypus.Infile
Reads the input file on a line basis, adding each line to an ArrayList for later processing.
ReadLine - Class in platypus
Defines a ReadLine, which simply holds the line (as a string) and the line # from the imput file.
ReadLine() - Constructor for class platypus.ReadLine
 
ReadLine(int, String) - Constructor for class platypus.ReadLine
 
REGISTERED - Static variable in class platypus.TokTyp
 
RIGHT_MARGIN - Static variable in class platypus.TokTyp
 
rightMargin() - Static method in class platypus.DumpValue
Creates a string containing the line # and the value of the right margin when last set

S

S_SHARP - Static variable in class platypus.TokTyp
 
setActive(boolean) - Method in class platypus.pdf.Strikethru
 
setAlignment(int) - Method in class platypus.GDD
 
setAmount(float) - Method in class platypus.pdf.Leading
 
setAmount(UnitValue) - Method in class platypus.pdf.Leading
used by the leading command [leading:xxx] The xxx portions is passed to a UnitValue which extracts the quantity and the units.
setAmountInPoints(float) - Method in class platypus.CommandValue
 
setBottomMargin(float) - Method in class platypus.GDD
 
setContent(String) - Method in class platypus.ReadLine
 
setCurrFont(PlatyFont) - Method in class platypus.GDD
 
setCurrFontSize(float) - Method in class platypus.GDD
 
setCustomPageHeight(String) - Method in class platypus.pdf.PageSize
sets page height to a custom amount (not using of the many predefined page sizes)
setCustomPageWidth(String) - Method in class platypus.pdf.PageSize
sets page width to a custom amount (not using one of the many predefined sizes)
setEnabled(boolean) - Method in class platypus.pdf.Underline
 
setInfile(Infile) - Method in class platypus.GID
 
setLeadingChangedSwitch(boolean) - Method in class platypus.pdf.Leading
 
setLeftMargin(float) - Method in class platypus.GDD
 
setLineNumber(int) - Method in class platypus.ReadLine
Set line number
setMirrorMargin(boolean) - Method in class platypus.GDD
 
setNoIndent(boolean) - Method in class platypus.GDD
 
setOutFileIsOpen() - Method in class platypus.GDD
 
setOutFilename(String) - Method in class platypus.GDD
 
setOutFileType(GDD.FileType) - Method in class platypus.GDD
 
setPagesToSkip(int) - Method in class platypus.pdf.PageFooter
Set the number of pages to skip before the footer is first printed.
setPlatyFont(PlatyFont) - Method in class platypus.pdf.PageFooter
 
setRightMargin(float) - Method in class platypus.GDD
 
setSize(float) - Method in class platypus.PlatyFont
 
setTextProcessedFlag() - Method in class platypus.GDD
 
setTokens(Tokens) - Method in class platypus.GID
 
setTopMargin(float) - Method in class platypus.GDD
 
setTypeface(String) - Method in class platypus.PlatyFont
 
setupFont() - Method in class platypus.PlatyFont
Does the actual heavy lifting of setting up the new font.
setupLogger() - Method in class platypus.GDD
set up the logger we'll use
setValue(A) - Method in class platypus.Value
Setter for value (but returns set value object as a convenience.
showUsage() - Static method in class platypus.Platypus
Prints the usage message to the console, unless gdd.logger is set to no messages (which only occurs in unit testing)
size - Variable in class platypus.PlatyFont
size of font in points
sizeof() - Method in class platypus.UserString
How many strings are there in the table?
startsWithEndOfBlockComment(String) - Method in class platypus.Infile
Determines whether a line that starts with %% is part of a closing comment block.
stateError(String) - Method in class platypus.CommandValue
Prints some kind of error message.
stateError(String) - Method in class platypus.FontSize
Error handling routine for invalid font size
stateError(String) - Method in class platypus.Margin
 
stateError(String) - Method in class platypus.pdf.ParaIndent
 
stateError(String) - Method in class platypus.pdf.ParaSkip
 
status - Variable in class platypus.OutputSpecialChar
Set to Status.INVALID_TOKEN if charCode not supported.
Status - Class in platypus
Status and error codes used in Platypus
Status() - Constructor for class platypus.Status
 
strikethru - Variable in class platypus.GDD
 
Strikethru - Class in platypus.pdf
Manage strikethrough characteristics of text
Strikethru() - Constructor for class platypus.pdf.Strikethru
 
STRIKETHRU_OFF - Static variable in class platypus.TokTyp
 
STRIKETHRU_ON - Static variable in class platypus.TokTyp
 
strikethruActive - Variable in class platypus.pdf.Strikethru
 
stripBlockComments() - Method in class platypus.Infile
Remove block comments from textLines array.

T

TEXT - Static variable in class platypus.TokTyp
 
textLineIndex - Static variable in class platypus.Infile
this is the index to the textLines ArrayList that holds the lines of text.
textLines - Variable in class platypus.Infile
array of ReadLines into which Infile is parsed
textProcessedFlag - Variable in class platypus.GDD
have we processed text so far?
thisInstance - Static variable in class platypus.GDD
 
thisInstance - Static variable in class platypus.GID
fields and functions needed for instantiation of singleton
thisInstance - Static variable in class platypus.Literals
 
Token - Class in platypus
Process the token from the input line of text.
Token(int, String) - Constructor for class platypus.Token
create a token consisting of the token type and its contents
tokens - Variable in class platypus.GID
 
Tokens - Class in platypus
Convenience class for handling an array of tokens (that constitute an input line)
Tokens(int) - Constructor for class platypus.Tokens
 
toks - Variable in class platypus.Tokens
 
TokTyp - Class in platypus
Types for the various input and command tokens, plus special characters and symbols.
TokTyp() - Constructor for class platypus.TokTyp
 
tooLateError() - Method in class platypus.pdf.PageSize
Logs an error when the user tries to change the size of the page after any text has been emitted.
TOP_MARGIN - Static variable in class platypus.TokTyp
 
topMargin() - Static method in class platypus.DumpValue
Creates a string containing the line # and the value of the top margin when last set
toString() - Method in class platypus.PlatyVersion
returns the version number for use elsewhere in the software
toString() - Method in class platypus.UserString
Dump all the strings in the table to one long string.
type - Variable in class platypus.Token
 
type - Variable in class platypus.UnitValue
 
typeface - Variable in class platypus.PlatyFont
name of typeface as used by iText

U

U_ACUTE - Static variable in class platypus.TokTyp
 
U_BREVE - Static variable in class platypus.TokTyp
 
U_CAP_ACUTE - Static variable in class platypus.TokTyp
 
U_CAP_BREVE - Static variable in class platypus.TokTyp
 
U_CAP_CARON - Static variable in class platypus.TokTyp
 
U_CAP_CIRCLE - Static variable in class platypus.TokTyp
 
U_CAP_CIRCUMFLEX - Static variable in class platypus.TokTyp
 
U_CAP_GRAVE - Static variable in class platypus.TokTyp
 
U_CAP_MACRON - Static variable in class platypus.TokTyp
 
U_CAP_TILDE - Static variable in class platypus.TokTyp
 
U_CAP_UMLAUT - Static variable in class platypus.TokTyp
 
U_CARON - Static variable in class platypus.TokTyp
 
U_CIRCLE - Static variable in class platypus.TokTyp
 
U_CIRCUMFLEX - Static variable in class platypus.TokTyp
 
U_GRAVE - Static variable in class platypus.TokTyp
 
U_MACRON - Static variable in class platypus.TokTyp
 
U_TILDE - Static variable in class platypus.TokTyp
 
U_UMLAUT - Static variable in class platypus.TokTyp
 
UNCLOSED_COMMAND - Static variable in class platypus.Status
 
UNCLOSED_COMMENT_BLK - Static variable in class platypus.Status
 
underline - Variable in class platypus.GDD
 
Underline - Class in platypus.pdf
Handle underlining of text.
Underline() - Constructor for class platypus.pdf.Underline
 
UNDERLINE_OFF - Static variable in class platypus.TokTyp
 
UNDERLINE_ON - Static variable in class platypus.TokTyp
 
units - Variable in class platypus.CommandValue
the type of units (lines, pts, inches, centimeters)
UnitValue - Class in platypus
Parses part of a command to determine the number of units and the type of units specified.
UnitValue(String) - Constructor for class platypus.UnitValue
Parses a string for the number of units and their type (e.g.
UNREACHABLE_ERR - Static variable in class platypus.Status
 
UNSUPPORTED_FORMAT_ERR - Static variable in class platypus.Status
 
UNUSED_COMMAND - Static variable in class platypus.TokTyp
 
update(String, String) - Method in class platypus.UserString
Updates a value by deleting the current KV pair and replacing it with the new one
UserString - Class in platypus
Maintains a hash list of defined strings.
UserString() - Constructor for class platypus.UserString
Create a table for key-value pairs (both strings)
uStrings - Variable in class platypus.UserString
 

V

value - Variable in class platypus.GDD.ValueBool
 
value - Variable in class platypus.UnitValue
 
Value<A> - Class in platypus
 
Value(A) - Constructor for class platypus.Value
 
Value(A, int) - Constructor for class platypus.Value
 
value - Variable in class platypus.Value
 
valueOf(String) - Static method in enum platypus.GDD.FileType
Returns the enum constant of this type with the specified name.
values() - Static method in enum platypus.GDD.FileType
Returns an array containing the constants of this enum type, in the order they're declared.
VERSION - Static variable in class platypus.PlatyVersion
string containing the version number shown in the copyright notice

W

width - Variable in class platypus.pdf.PageSize
page width in points

A B C D E F G H I L M N O P R S T U V W
Platypus

Copyright © 2006-7 Pacific Data Works LLC. (http://platypus.pz.org)