|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.pz.platypus.plugin.common.DocData
public abstract class DocData
Abstract container class for all the state of the output document. Derived classes are created for the PDF, RTF, etc. plugins.
Nested Class Summary | |
---|---|
static class |
DocData.Value
Inner class containing the value of the data item, plus the line at which it was las changed. |
Field Summary | |
---|---|
private DocData.Value |
alignment
|
private DocData.Value |
codeSection
|
protected DocData.Value |
columnCount
|
private ICommandTable |
commandTable
|
private int |
currColumn
|
private DocData.Value |
firstLineIndent
|
private GDD |
gdd
|
private boolean |
inCodeListing
|
private DocData.Value |
leading
|
private DocData.Value |
lineHeight
|
private DocData.Value |
lineNumberLast
|
private DocData.Value |
lineNumberSkip
|
private DocData.Value |
marginBottom
|
private DocData.Value |
marginLeft
|
private DocData.Value |
marginRight
|
private DocData.Value |
marginsMirrored
|
private DocData.Value |
marginTop
|
private DocData.Value |
noIndent
|
private DocData.Value |
pageHeight
|
private int |
pageNumber
|
private DocData.Value |
pageWidth
|
private DocData.Value |
paragraphIndent
|
private DocData.Value |
paragraphIndentRight
|
private DocData.Value |
paragraphSkip
|
private DocData.Value |
pixelsPerInch
|
private DocData.Value |
strikethru
|
protected Underline |
underline
|
private DocData.Value |
userSpecifiedColumnWidth
|
Constructor Summary | |
---|---|
DocData()
Default ctor |
|
DocData(GDD gddIn)
Initializes the state of the PDF document. |
Method Summary | |
---|---|
int |
getAlignment()
|
Source |
getAlignmentLine()
|
Source |
getCodeSectionLine()
|
int |
getColumnCount()
|
Source |
getColumnCountLine()
|
ICommandTable |
getCommandTable()
|
int |
getCurrColumn()
|
float |
getFirstLineIndent()
|
Source |
getFirstLineIndentLine()
|
GDD |
getGdd()
|
float |
getLeading()
|
Source |
getLeadingLine()
|
float |
getLineHeight()
|
Source |
getLineHeightLine()
|
int |
getLineNumberLast()
|
Source |
getLineNumberLastLine()
|
int |
getLineNumberSkip()
|
Source |
getLineNumberSkipLine()
|
float |
getMarginBottom()
|
Source |
getMarginBottomLine()
|
float |
getMarginLeft()
|
Source |
getMarginLeftLine()
|
float |
getMarginRight()
|
Source |
getMarginRightLine()
|
boolean |
getMarginsMirrored()
|
Source |
getMarginsMirroredLine()
|
float |
getMarginTop()
|
Source |
getMarginTopLine()
|
boolean |
getNoIndent()
|
Source |
getNoIndentLine()
|
float |
getPageHeight()
|
Source |
getPageHeightLine()
|
int |
getPageNumber()
|
float |
getPageWidth()
|
Source |
getPageWidthLine()
|
float |
getParagraphIndent()
|
Source |
getParagraphIndentLine()
|
float |
getParagraphIndentRight()
|
Source |
getParagraphIndentRightLine()
|
float |
getParagraphSkip()
|
int |
getParagraphSkipLine()
|
float |
getPixelsPerInch()
|
Source |
getPixelsPerInchLine()
|
boolean |
getStrikethru()
|
int |
getStrikethruLine()
|
Underline |
getUnderline()
|
float |
getUserSpecifiedColumnWidth()
|
Source |
getUserSpecifiedColumnWidthLine()
|
boolean |
inCodeSection()
|
void |
init()
Some data items need additional initialization. |
boolean |
isInCodeListing()
|
void |
setAlignment(int newAlignment,
Source fileAndLine)
|
void |
setColumnCount(int newCount,
Source fileAndLine)
|
void |
setCommandTable(ICommandTable newTable)
|
void |
setCurrColumn(int newColNumber)
|
void |
setFirstLineIndent(float newFirstLineIndent,
Source fileAndLine)
|
void |
setInCodeListing(boolean isListing)
|
void |
setInCodeSection(boolean inCode,
Source fileAndLine)
|
void |
setLeading(float newLeading,
Source fileAndLine)
|
void |
setLineHeight(float newLineHeight,
Source fileAndLine)
|
void |
setLineNumberLast(int newLastLineNumber,
Source fileAndLine)
|
void |
setLineNumberSkip(int newLineNumberSkip,
Source fileAndLine)
|
void |
setMarginBottom(float val,
Source fileAndLine)
|
void |
setMarginLeft(float val,
Source fileAndLine)
|
void |
setMarginRight(float val,
Source fileAndLine)
|
void |
setMarginsMirrored(boolean trueFalse,
Source fileAndLine)
|
void |
setMarginTop(float val,
Source fileAndLine)
|
void |
setNoIndent(boolean trueFalse,
Source fileAndLine)
|
void |
setPageHeight(float val,
Source fileAndLine)
|
void |
setPageNumber(int newPageNumber)
|
void |
setPageWidth(float val,
Source fileAndLine)
|
void |
setParagraphIndent(float newParagraphIndent,
Source fileAndLine)
|
void |
setParagraphIndentRight(float newParagraphIndentRight,
Source fileAndLine)
|
void |
setParagraphSkip(float val,
Source fileAndLine)
|
void |
setStrikethru(boolean newStrikethru,
Source fileAndLine)
|
void |
setUserSpecifiedColumnWidth(float newWidth,
Source fileAndLine)
|
void |
setValue(DocData.Value field,
boolean val,
Source fileAndLine,
java.lang.String name)
Sets the new boolean value, updates line number, and table in systemStrings |
void |
setValue(DocData.Value field,
float val,
Source fileAndLine,
java.lang.String name)
Sets the new float value, updates line number, and table in systemStrings |
void |
setValue(DocData.Value field,
int val,
Source fileAndLine,
java.lang.String name)
Sets the new int value, updates line number, and table in systemStrings |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private GDD gdd
private DocData.Value alignment
private DocData.Value codeSection
protected DocData.Value columnCount
private DocData.Value userSpecifiedColumnWidth
private ICommandTable commandTable
private int currColumn
private DocData.Value firstLineIndent
private boolean inCodeListing
private DocData.Value leading
private DocData.Value lineHeight
private DocData.Value lineNumberSkip
private DocData.Value lineNumberLast
private DocData.Value marginBottom
private DocData.Value marginLeft
private DocData.Value marginRight
private DocData.Value marginTop
private DocData.Value marginsMirrored
private DocData.Value noIndent
private DocData.Value pageHeight
private int pageNumber
private DocData.Value pageWidth
private DocData.Value paragraphIndent
private DocData.Value paragraphIndentRight
private DocData.Value paragraphSkip
private DocData.Value pixelsPerInch
private DocData.Value strikethru
protected Underline underline
Constructor Detail |
---|
public DocData()
public DocData(GDD gddIn)
gddIn
- the GDDMethod Detail |
---|
public void init()
public void setValue(DocData.Value field, float val, Source fileAndLine, java.lang.String name)
field
- the Value field to be updatedval
- the new floating-point valuefileAndLine
- the file and line number where the change occurredname
- the key to look up the string in systemStringspublic void setValue(DocData.Value field, int val, Source fileAndLine, java.lang.String name)
field
- the Value field to be updatedval
- the new integer valuefileAndLine
- the file and line number where the change occurredname
- the key to look up the string in systemStringspublic void setValue(DocData.Value field, boolean val, Source fileAndLine, java.lang.String name)
field
- the Value field to be updatedval
- the new floating-point valuefileAndLine
- the file and line number where the change occurredname
- the key to look up the string in systemStringspublic int getAlignment()
public Source getAlignmentLine()
public void setAlignment(int newAlignment, Source fileAndLine)
public boolean inCodeSection()
inCodeSection
in interface IOutputContext
public Source getCodeSectionLine()
public void setInCodeSection(boolean inCode, Source fileAndLine)
public int getColumnCount()
public Source getColumnCountLine()
public void setColumnCount(int newCount, Source fileAndLine)
public ICommandTable getCommandTable()
public void setCommandTable(ICommandTable newTable)
public int getCurrColumn()
public void setCurrColumn(int newColNumber)
public float getFirstLineIndent()
public Source getFirstLineIndentLine()
public void setFirstLineIndent(float newFirstLineIndent, Source fileAndLine)
public GDD getGdd()
getGdd
in interface IOutputContext
public boolean isInCodeListing()
public void setInCodeListing(boolean isListing)
public float getLeading()
public Source getLeadingLine()
public void setLeading(float newLeading, Source fileAndLine)
public float getLineHeight()
public Source getLineHeightLine()
public void setLineHeight(float newLineHeight, Source fileAndLine)
public int getLineNumberLast()
public Source getLineNumberLastLine()
public void setLineNumberLast(int newLastLineNumber, Source fileAndLine)
setLineNumberLast
in interface IOutputContext
public int getLineNumberSkip()
public Source getLineNumberSkipLine()
public void setLineNumberSkip(int newLineNumberSkip, Source fileAndLine)
setLineNumberSkip
in interface IOutputContext
public float getMarginBottom()
public Source getMarginBottomLine()
public void setMarginBottom(float val, Source fileAndLine)
public float getMarginLeft()
public Source getMarginLeftLine()
public void setMarginLeft(float val, Source fileAndLine)
public float getMarginRight()
public Source getMarginRightLine()
public void setMarginRight(float val, Source fileAndLine)
public float getMarginTop()
public Source getMarginTopLine()
public void setMarginTop(float val, Source fileAndLine)
public boolean getMarginsMirrored()
public Source getMarginsMirroredLine()
public void setMarginsMirrored(boolean trueFalse, Source fileAndLine)
public boolean getNoIndent()
public Source getNoIndentLine()
public void setNoIndent(boolean trueFalse, Source fileAndLine)
public float getPageHeight()
public Source getPageHeightLine()
public void setPageHeight(float val, Source fileAndLine)
public int getPageNumber()
public void setPageNumber(int newPageNumber)
public float getPageWidth()
public Source getPageWidthLine()
public void setPageWidth(float val, Source fileAndLine)
public float getParagraphIndent()
public Source getParagraphIndentLine()
public void setParagraphIndent(float newParagraphIndent, Source fileAndLine)
public float getParagraphIndentRight()
public Source getParagraphIndentRightLine()
public void setParagraphIndentRight(float newParagraphIndentRight, Source fileAndLine)
public float getParagraphSkip()
public int getParagraphSkipLine()
public void setParagraphSkip(float val, Source fileAndLine)
public float getPixelsPerInch()
public Source getPixelsPerInchLine()
public boolean getStrikethru()
public int getStrikethruLine()
public void setStrikethru(boolean newStrikethru, Source fileAndLine)
public Underline getUnderline()
public float getUserSpecifiedColumnWidth()
public Source getUserSpecifiedColumnWidthLine()
public void setUserSpecifiedColumnWidth(float newWidth, Source fileAndLine)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |