org.apache.fop.render.afp.modca
Class 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.
AbstractPageObject(String name, int width, int height, int rotation) - Construct a new page object for the specified name argument, the page
name should be an 8 character identifier.
|
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(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 rotation, 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(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(String name, String value) - Creates a TagLogicalElement on the page.
|
void | createText(int fontNumber, int x, int y, int rotation, 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
|
_activeEnvironmentGroup
protected ActiveEnvironmentGroup _activeEnvironmentGroup
The active environment group for the page
_objects
protected List _objects
The list of objects within the page
_segments
protected ArrayList _segments
The list of the include page segments
_tagLogicalElements
protected ArrayList _tagLogicalElements
The list of tag logical elements
AbstractPageObject
public AbstractPageObject(String name,
int width,
int height,
int rotation)
Construct a new page object for the specified name argument, the page
name should be an 8 character identifier.
name
- the name of the page.width
- the width of the page.height
- the height of the page.rotation
- the rotation of the page.
createFont
public 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.
fontReference
- the font number used as the resource identifierfont
- the fontsize
- the point size of the font
createIncludePageSegment
public void createIncludePageSegment(String name,
int xCoor,
int yCoor)
Creates an IncludePageSegment on the current page.
name
- the name of the page segmentxCoor
- the x cooridinate of the page segment.yCoor
- the y cooridinate of the page segment.
createLine
public void createLine(int x1,
int y1,
int x2,
int y2,
int thickness,
int rotation,
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.
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 linerotation
- the rotation of the linecol
- The text color.
createNoOperation
public void createNoOperation(String content)
Creates a NoOperation on the page.
createShading
public 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).
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 value
createTagLogicalElement
public void createTagLogicalElement(String name,
String value)
Creates a TagLogicalElement on the page.
name
- the name of the tagvalue
- the value of the tag
createText
public void createText(int fontNumber,
int x,
int y,
int rotation,
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.
fontNumber
- the font number used as the resource identifierx
- the x coordinate of the text datay
- the y coordinate of the text datarotation
- the rotation of the text datacol
- the text colorvsci
- The variable space character increment.ica
- The inter character adjustment.data
- the text data to create
endPage
public void endPage()
Helper method to mark the end of the page. This should end the control
sequence on the current presenation text object.
getActiveEnvironmentGroup
public ActiveEnvironmentGroup getActiveEnvironmentGroup()
Returns the ActiveEnvironmentGroup associated with this page.
- the ActiveEnvironmentGroup object
getHeight
public int getHeight()
Returns the height of the page
getImageObject
public ImageObject getImageObject()
Helper method to create an image on the current page and to return
the object.
getRotation
public int getRotation()
Returns the rotation of the page
getWidth
public int getWidth()
Returns the width of the page
isComplete
public boolean isComplete()
Returns an indication if the page is complete
Copyright 1999-2007 The Apache Software Foundation. All Rights Reserved.