|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.pz.platypus.plugin.rtf.Start
public class Start
Test plugin for converting Platypus files to Rich Text Format (rtf). Note: Methods order: constructor, methods in alphabetical order, getters and setters Error-handling convention: Output plugins handle all their own error messages. Platypus is made aware of a problem only by the value returned from calling process(). However, it does not issue any user messages as a result of this.
Field Summary | |
---|---|
private RtfCommandTable |
ctable
|
private RtfOutfile |
outfile
|
private RtfData |
rtd
|
Constructor Summary | |
---|---|
Start()
Start() is always called first by Platypus, followed by a call to process() Any plugin initialization code should go in here. |
Method Summary | |
---|---|
void |
emitListing(java.io.FileWriter outfile,
GDD gdd)
Where the content of the listing file is written out |
void |
process(GDD gdd,
CommandLineArgs clArgs)
This is the main line of the plug-in. |
void |
processCommand(GDD gdd,
RtfCommandTable commandTable,
Token tok,
int tokNum)
Gets the RTF command and executes it. |
void |
processInputTokens(GDD gdd,
RtfOutfile outfile)
Where the content of the listing file is written out |
void |
processText(GDD gdd,
Token tok,
RtfOutfile outfile)
Validates that there is text to output and then writes it as a string to the file. |
int |
processToken(GDD gdd,
Token tok,
RtfOutfile outfile,
int tokenNumber)
Processes the individual tokens |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private RtfOutfile outfile
private RtfData rtd
private RtfCommandTable ctable
Constructor Detail |
---|
public Start()
Method Detail |
---|
public void process(GDD gdd, CommandLineArgs clArgs)
process
in interface IPlugin
gdd
- The Global Document Data structureclArgs
- command-line arguments in a hash map (key = argument, value = parameters)public void processInputTokens(GDD gdd, RtfOutfile outfile) throws java.io.IOException
outfile
- the file being written togdd
- the GDD.
java.io.IOException
- in the event the file can't be written topublic int processToken(GDD gdd, Token tok, RtfOutfile outfile, int tokenNumber) throws java.io.IOException
gdd
- global document data (data structure)tok
- token being processedoutfile
- output RTF file being createdtokenNumber
- where the token is in the input token stream
java.io.IOException
- in event of an I/O errorpublic void processCommand(GDD gdd, RtfCommandTable commandTable, Token tok, int tokNum) throws java.io.IOException
gdd
- the GDDcommandTable
- the command table holding the commands for RTFtok
- the token containing texttokNum
- the number of the token
java.io.IOException
- occurs if an I/O error occurred during outputpublic void processText(GDD gdd, Token tok, RtfOutfile outfile) throws java.io.IOException
gdd
- the GDDtok
- the token containing textoutfile
- the file to write the text to
java.io.IOException
- occurs if an I/O error occurred during outputpublic void emitListing(java.io.FileWriter outfile, GDD gdd) throws java.io.IOException
outfile
- the file being written togdd
- the GDD. Only the literals are used
java.io.IOException
- in the event the file can't be written to
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |