fop 0.94 | |
Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.fop.render.afp.modca.AFPDataStream
public class AFPDataStream
extends java.lang.Object
Field Summary | |
protected static Log |
|
Constructor Summary | |
|
Method Summary | |
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
ImageObject |
|
void |
|
PageObject |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
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 current page.
- Parameters:
fontReference
- the font number used as the resource identifierfont
- the fontsize
- the point size of the font
public void createIncludePageOverlay(String name)
Helper method which allows creation of the MPO object, via the AEG. And the IPO via the Page. (See actual object for descriptions.)
- Parameters:
name
- the name of the static overlay
public void createIncludePageSegment(String name, int x, int y)
Creates an IncludePageSegment on the current page.
- Parameters:
name
- the name of the include page segmentx
- the x coordinate for the overlayy
- the y coordinate for the overlay
public void createInvokeMediumMap(String name)
Helper method which allows creation of the IMM object.
- Parameters:
name
- the name of the medium map
public void createLine(int x1, int y1, int x2, int y2, int thickness, Color col)
Method to create a line on the current page.
- Parameters:
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 linecol
- The text color.
public void createNoOperation(String content)
Creates a NoOperation item
- Parameters:
content
- byte data
public void createPageGroupTagLogicalElement(TagLogicalElementBean[] attributes)
Creates a TagLogicalElement on the current page group.
- Parameters:
attributes
- the array of key value pairs.
public void createPageTagLogicalElement(TagLogicalElementBean[] attributes)
Creates a TagLogicalElement on the current page.
- Parameters:
attributes
- the array of key value pairs.
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).
- Parameters:
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
public void createTagLogicalElement(String name, String value)
Creates a TagLogicalElement on the current page or page group
- Parameters:
name
- The tag namevalue
- The tag value
public void createText(int fontNumber, int x, int y, Color col, int vsci, int ica, byte[] data)
Helper method to create text on the current page, this method delegates to the current presentation text object in order to construct the text.
- Parameters:
fontNumber
- the font number used as the resource identifierx
- the x coordinate of the texty
- the y coordinate of the textcol
- the text colorvsci
- The variable space character increment.ica
- The inter character adjustment.data
- the text data to create
public void endDocument() throws IOException
The document is ended by invoking this method which creates an instance of the AFP Document object and registers the start with a validation map which ensures that methods are not invoked out of the correct sequence.
public void endOverlay()
Helper method to mark the end of the current overlay.
public void endPage() throws IOException
Helper method to mark the end of the current page.
public void endPageGroup() throws IOException
Helper method to mark the end of the page group.
public ImageObject getImageObject(int x, int y, int w, int h)
Returns an ImageObject used to create an image in the datastream.
- Parameters:
x
- the x position of the imagey
- the y position of the imagew
- the width of the imageh
- the height of the image
public void restorePage(PageObject pageObject)
Helper method to restore the current page.
public void setLandscapeRotation(int rotation)
Sets the rotation to be used for landscape pages, valid values are 0, 90, 180, 270 (default).
- Parameters:
rotation
- The rotation in degrees.
public void setOffsets(int xOffset, int yOffset, int rotation)
Sets the offsets to be used for element positioning
- Parameters:
xOffset
- the offset in the x directionyOffset
- the offset in the y directionrotation
- the rotation
public void setPortraitRotation(int rotation)
Sets the rotation to be used for portrait pages, valid values are 0 (default), 90, 180, 270.
- Parameters:
rotation
- The rotation in degrees.
public void startDocument(OutputStream outputStream)
The document is started by invoking this method which creates an instance of the AFP Document object.
public void startOverlay(int overlayX, int overlayY, int overlayWidth, int overlayHeight, int overlayRotation)
Start a new overlay. When processing has finished on the current overlay, theendOverlay()
method must be invoked to mark the overlay ending.
- Parameters:
overlayX
- the x position of the overlay on the pageoverlayY
- the y position of the overlay on the pageoverlayWidth
- the width of the overlayoverlayHeight
- the height of the overlayoverlayRotation
- the rotation of the overlay
public void startPage(int pageWidth, int pageHeight, int pageRotation)
Start a new page. When processing has finished on the current page, theendPage()
method must be invoked to mark the page ending.
- Parameters:
pageWidth
- the width of the pagepageHeight
- the height of the pagepageRotation
- the rotation of the page
public void startPageGroup()
Start a new page group. When processing has finished on the current page group theendPageGroup()
method must be invoked to mark the page group ending.
- Parameters:
fop 0.94 |