|
fop 0.95 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.fop.render.afp.modca.AbstractAFPObject
org.apache.fop.render.afp.modca.AbstractNamedAFPObject
org.apache.fop.render.afp.modca.AbstractPageObject
public abstract class AbstractPageObject
Pages contain the data objects that comprise a presentation document. Each page has a set of data objects associated with it. Each page within a document is independent from any other page, and each must establish its own environment parameters. The page is the level in the document component hierarchy that is used for printing or displaying a document's content. The data objects contained in the page envelope in the data stream are presented when the page is presented. Each data object has layout information associated with it that directs the placement and orientation of the data on the page. In addition, each page contains layout information that specifies the measurement units, page width, and page depth. A page is initiated by a begin page structured field and terminated by an end page structured field. Structured fields that define objects and active environment groups or that specify attributes of the page may be encountered in page state.
Field Summary | |
---|---|
protected ActiveEnvironmentGroup |
activeEnvironmentGroup
The active environment group for the page |
protected java.util.List |
objects
The list of objects within the page |
protected java.util.ArrayList |
segments
The list of the include page segments |
protected java.util.ArrayList |
tagLogicalElements
The list of tag logical elements |
Fields inherited from class org.apache.fop.render.afp.modca.AbstractNamedAFPObject |
---|
name, nameBytes |
Fields inherited from class org.apache.fop.render.afp.modca.AbstractAFPObject |
---|
log |
Constructor Summary | |
---|---|
AbstractPageObject(java.lang.String name,
int width,
int height,
int rotation,
int widthResolution,
int heightResolution)
Construct a new page object for the specified name argument, the page name should be an 8 character identifier. |
Method Summary | |
---|---|
void |
createFont(byte fontReference,
AFPFont font,
int size)
Helper method to create a map coded font object on the current page, this method delegates the construction of the map coded font object to the active environment group on the page. |
void |
createIncludePageSegment(java.lang.String name,
int xCoor,
int yCoor)
Creates an IncludePageSegment on the current page. |
void |
createLine(int x1,
int y1,
int x2,
int y2,
int thickness,
int lineRotation,
java.awt.Color col)
Helper method to create a line on the current page, this method delegates to the presentation text object in order to construct the line. |
void |
createNoOperation(java.lang.String content)
Creates a NoOperation on the page. |
void |
createShading(int x,
int y,
int w,
int h,
int red,
int green,
int blue)
This method will create shading on the page using the specified coordinates (the shading contrast is controlled via the red, green blue parameters, by converting this to grey scale). |
void |
createTagLogicalElement(java.lang.String name,
java.lang.String value)
Creates a TagLogicalElement on the page. |
void |
createText(int fontNumber,
int x,
int y,
int textRotation,
java.awt.Color col,
int vsci,
int ica,
byte[] data)
Helper method to create text on the current page, this method delegates to the presentation text object in order to construct the text. |
void |
endPage()
Helper method to mark the end of the page. |
ActiveEnvironmentGroup |
getActiveEnvironmentGroup()
Returns the ActiveEnvironmentGroup associated with this page. |
int |
getHeight()
Returns the height of the page |
ImageObject |
getImageObject()
Helper method to create an image on the current page and to return the object. |
int |
getRotation()
Returns the rotation of the page |
int |
getWidth()
Returns the width of the page |
boolean |
isComplete()
Returns an indication if the page is complete |
Methods inherited from class org.apache.fop.render.afp.modca.AbstractAFPObject |
---|
writeDataStream, writeObjectList |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected ActiveEnvironmentGroup activeEnvironmentGroup
protected java.util.List objects
protected java.util.ArrayList tagLogicalElements
protected java.util.ArrayList segments
Constructor Detail |
---|
public AbstractPageObject(java.lang.String name, int width, int height, int rotation, int widthResolution, int heightResolution)
name
- the name of the page.width
- the width of the page.height
- the height of the page.rotation
- the rotation of the page.widthResolution
- the width resolution of the page.heightResolution
- the height resolution of the page.Method Detail |
---|
public void createFont(byte fontReference, AFPFont font, int size)
fontReference
- the font number used as the resource identifierfont
- the fontsize
- the point size of the fontpublic void createLine(int x1, int y1, int x2, int y2, int thickness, int lineRotation, java.awt.Color col)
x1
- the first x coordinate of the liney1
- the first y coordinate of the linex2
- the second x coordinate of the liney2
- the second y coordinate of the linethickness
- the thickness of the linelineRotation
- the rotation of the linecol
- The text color.public void createText(int fontNumber, int x, int y, int textRotation, java.awt.Color col, int vsci, int ica, byte[] data)
fontNumber
- the font number used as the resource identifierx
- the x coordinate of the text datay
- the y coordinate of the text datatextRotation
- the rotation of the text datacol
- the text colorvsci
- The variable space character increment.ica
- The inter character adjustment.data
- the text data to createpublic void endPage()
public void createShading(int x, int y, int w, int h, int red, int green, int blue)
x
- the x coordinate of the shadingy
- the y coordinate of the shadingw
- the width of the shaded areah
- the height of the shaded areared
- the red valuegreen
- the green valueblue
- the blue valuepublic ImageObject getImageObject()
public void createTagLogicalElement(java.lang.String name, java.lang.String value)
name
- the name of the tagvalue
- the value of the tagpublic void createNoOperation(java.lang.String content)
content
- the byte datapublic void createIncludePageSegment(java.lang.String name, int xCoor, int yCoor)
name
- the name of the page segmentxCoor
- the x cooridinate of the page segment.yCoor
- the y cooridinate of the page segment.public ActiveEnvironmentGroup getActiveEnvironmentGroup()
public boolean isComplete()
public int getHeight()
public int getWidth()
public int getRotation()
|
fop 0.95 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |