|
fop 1.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IFPainter
Interface used to paint whole documents layouted by Apache FOP.
Call sequence:
startDocument() startDocumentHeader() [handleExtension()]* endDocumentHeader() [ startPageSequence() [ startPage() startPageHeader() [handleExtension()]* endPageHeader() startPageContent() (#pageContent)+ endPageContent() startPageTrailer() (addTarget())* endPageTrailer() endPage() ]* endPageSequence() ]* startDocumentTrailer() [handleExtension()]* endDocumentTrailer() endDocument() #box: startBox() (#pageContent)+ endBox() #pageContent: ( setFont() | drawText() | drawRect() | drawImage() | TODO etc. etc. | handleExtensionObject() )
Method Summary | |
---|---|
void |
clipRect(java.awt.Rectangle rect)
Restricts the current clipping region with the given rectangle. |
void |
drawBorderRect(java.awt.Rectangle rect,
BorderProps before,
BorderProps after,
BorderProps start,
BorderProps end)
Draws a border rectangle. |
void |
drawImage(org.w3c.dom.Document doc,
java.awt.Rectangle rect)
Draws an image (represented by a DOM document) inside a given rectangle. |
void |
drawImage(java.lang.String uri,
java.awt.Rectangle rect)
Draws an image identified by a URI inside a given rectangle. |
void |
drawLine(java.awt.Point start,
java.awt.Point end,
int width,
java.awt.Color color,
RuleStyle style)
Draws a line. |
void |
drawText(int x,
int y,
int letterSpacing,
int wordSpacing,
int[] dx,
java.lang.String text)
Draws text. |
void |
endGroup()
Ends the current group and restores the previous coordinate system. |
void |
endViewport()
Ends the current viewport and restores the previous coordinate system. |
void |
fillRect(java.awt.Rectangle rect,
java.awt.Paint fill)
Fills a rectangular area. |
void |
setFont(java.lang.String family,
java.lang.String style,
java.lang.Integer weight,
java.lang.String variant,
java.lang.Integer size,
java.awt.Color color)
Updates the current font. |
void |
startGroup(java.awt.geom.AffineTransform transform)
Starts a new group of graphical elements. |
void |
startGroup(java.awt.geom.AffineTransform[] transforms)
Starts a new group of graphical elements. |
void |
startViewport(java.awt.geom.AffineTransform[] transforms,
java.awt.Dimension size,
java.awt.Rectangle clipRect)
Starts a new viewport, establishing a new coordinate system. |
void |
startViewport(java.awt.geom.AffineTransform transform,
java.awt.Dimension size,
java.awt.Rectangle clipRect)
Starts a new viewport, establishing a new coordinate system. |
Method Detail |
---|
void startViewport(java.awt.geom.AffineTransform transform, java.awt.Dimension size, java.awt.Rectangle clipRect) throws IFException
transform
- the transformation matrix establishing the new coordinate systemsize
- the size of the viewportclipRect
- the clipping rectangle (may be null)
IFException
- if an error occurs while handling this elementvoid startViewport(java.awt.geom.AffineTransform[] transforms, java.awt.Dimension size, java.awt.Rectangle clipRect) throws IFException
transforms
- a series of transformation matrices establishing the new coordinate systemsize
- the size of the viewportclipRect
- the clipping rectangle (may be null)
IFException
- if an error occurs while handling this elementvoid endViewport() throws IFException
IFException
- if an error occurs while handling this elementvoid startGroup(java.awt.geom.AffineTransform[] transforms) throws IFException
transforms
- a series of transformation matrices establishing the new coordinate system
IFException
- if an error occurs while handling this elementvoid startGroup(java.awt.geom.AffineTransform transform) throws IFException
transform
- the transformation matrix establishing the new coordinate system
IFException
- if an error occurs while handling this elementvoid endGroup() throws IFException
IFException
- if an error occurs while handling this elementvoid setFont(java.lang.String family, java.lang.String style, java.lang.Integer weight, java.lang.String variant, java.lang.Integer size, java.awt.Color color) throws IFException
family
- the font family (or null if there's no change)style
- the font style (or null if there's no change)weight
- the font weight (or null if there's no change)variant
- the font variant (or null if there's no change)size
- the font size (or null if there's no change)color
- the text color (or null if there's no change)
IFException
- if an error occurs while handling this eventvoid drawText(int x, int y, int letterSpacing, int wordSpacing, int[] dx, java.lang.String text) throws IFException
x
- X-coordinate of the starting point of the texty
- Y-coordinate of the starting point of the textletterSpacing
- additional spacing between characters (may be 0)wordSpacing
- additional spacing between words (may be 0)dx
- an array of adjustment values for each character in X-direction (may be null)text
- the text
IFException
- if an error occurs while handling this eventvoid clipRect(java.awt.Rectangle rect) throws IFException
rect
- the rectangle's coordinates and extent
IFException
- if an error occurs while handling this eventvoid fillRect(java.awt.Rectangle rect, java.awt.Paint fill) throws IFException
rect
- the rectangle's coordinates and extentfill
- the fill paint
IFException
- if an error occurs while handling this eventvoid drawBorderRect(java.awt.Rectangle rect, BorderProps before, BorderProps after, BorderProps start, BorderProps end) throws IFException
BorderProps
instances.
rect
- the rectangle's coordinates and extentbefore
- the border segment on the before-side (top)after
- the border segment on the after-side (bottom)start
- the border segment on the start-side (left)end
- the border segment on the end-side (right)
IFException
- if an error occurs while handling this eventvoid drawLine(java.awt.Point start, java.awt.Point end, int width, java.awt.Color color, RuleStyle style) throws IFException
start
- the start point of the lineend
- the end point of the linewidth
- the line widthcolor
- the line colorstyle
- the line style (using the Constants.EN_* constants for the rule-style property)
IFException
- if an error occurs while handling this eventvoid drawImage(java.lang.String uri, java.awt.Rectangle rect) throws IFException
uri
- the image's URIrect
- the rectangle in which the image shall be painted
IFException
- if an error occurs while handling this eventvoid drawImage(org.w3c.dom.Document doc, java.awt.Rectangle rect) throws IFException
doc
- the DOM document containing the foreign objectrect
- the rectangle in which the image shall be painted
IFException
- if an error occurs while handling this event
|
fop 1.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |