public interface IFPainter
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() )
Modifier and Type | Method and Description |
---|---|
void |
clipBackground(Rectangle rect,
BorderProps bpsBefore,
BorderProps bpsAfter,
BorderProps bpsStart,
BorderProps bpsEnd)
Restricts the current clipping region to the inner border.
|
void |
clipRect(Rectangle rect)
Restricts the current clipping region with the given rectangle.
|
void |
drawBorderRect(Rectangle rect,
BorderProps top,
BorderProps bottom,
BorderProps left,
BorderProps right,
Color innerBackgroundColor)
Draws a border rectangle.
|
void |
drawImage(Document doc,
Rectangle rect)
Draws an image (represented by a DOM document) inside a given rectangle.
|
void |
drawImage(String uri,
Rectangle rect)
Draws an image identified by a URI inside a given rectangle.
|
void |
drawLine(Point start,
Point end,
int width,
Color color,
RuleStyle style)
Draws a line.
|
void |
drawText(int x,
int y,
int letterSpacing,
int wordSpacing,
int[][] dp,
String text)
Draws text.
|
void |
drawText(int x,
int y,
int letterSpacing,
int wordSpacing,
int[][] dp,
String text,
boolean nextIsSpace) |
void |
endGroup()
Ends the current group and restores the previous coordinate system (and layer).
|
void |
endViewport()
Ends the current viewport and restores the previous coordinate system.
|
void |
fillRect(Rectangle rect,
Paint fill)
Fills a rectangular area.
|
boolean |
isBackgroundRequired(BorderProps bpsBefore,
BorderProps bpsAfter,
BorderProps bpsStart,
BorderProps bpsEnd)
TODO Painter-specific rounded borders logic required background drawing to be
made optional.
|
void |
setFont(String family,
String style,
Integer weight,
String variant,
Integer size,
Color color)
Updates the current font.
|
void |
startGroup(AffineTransform[] transforms,
String layer)
Starts a new group of graphical elements.
|
void |
startGroup(AffineTransform transform,
String layer)
Starts a new group of graphical elements.
|
void |
startViewport(AffineTransform[] transforms,
Dimension size,
Rectangle clipRect)
Starts a new viewport, establishing a new coordinate system.
|
void |
startViewport(AffineTransform transform,
Dimension size,
Rectangle clipRect)
Starts a new viewport, establishing a new coordinate system.
|
void startViewport(AffineTransform transform, Dimension size, 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(AffineTransform[] transforms, Dimension size, 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(AffineTransform[] transforms, String layer) throws IFException
transforms
- a series of transformation matrices establishing the new coordinate systemlayer
- an optional layer label (or null if none)IFException
- if an error occurs while handling this elementvoid startGroup(AffineTransform transform, String layer) throws IFException
transform
- the transformation matrix establishing the new coordinate systemlayer
- an optional layer label (or null if none)IFException
- if an error occurs while handling this elementvoid endGroup() throws IFException
IFException
- if an error occurs while handling this elementvoid setFont(String family, String style, Integer weight, String variant, Integer size, 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[][] dp, 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)dp
- an array of 4-tuples, expressing [X,Y] placment
adjustments and [X,Y] advancement adjustments, in that order (may be null); if
not null, then adjustments.length must be the same as text.length()text
- the textIFException
- if an error occurs while handling this eventvoid drawText(int x, int y, int letterSpacing, int wordSpacing, int[][] dp, String text, boolean nextIsSpace) throws IFException
IFException
void clipRect(Rectangle rect) throws IFException
rect
- the rectangle's coordinates and extentIFException
- if an error occurs while handling this eventvoid clipBackground(Rectangle rect, BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd) throws IFException
rect
- the rectangle's coordinates and extentbpsBefore
- the border segment on the before-side (top)bpsAfter
- the border segment on the after-side (bottom)bpsStart
- the border segment on the start-side (left)bpsEnd
- the border segment on the end-side (right)IFException
- if an error occurs while handling this eventboolean isBackgroundRequired(BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd)
bpsBefore
- the before borderbpsAfter
- the after borderbpsStart
- the start borderbpsEnd
- the end bordervoid fillRect(Rectangle rect, Paint fill) throws IFException
rect
- the rectangle's coordinates and extentfill
- the fill paintIFException
- if an error occurs while handling this eventvoid drawBorderRect(Rectangle rect, BorderProps top, BorderProps bottom, BorderProps left, BorderProps right, Color innerBackgroundColor) throws IFException
BorderProps
instances.rect
- the rectangle's coordinates and extenttop
- the border segment on the top edgebottom
- the border segment on the bottom edgeleft
- the border segment on the left edgeright
- the border segment on the right edgeinnerBackgroundColor
- the color of the inner backgroundIFException
- if an error occurs while handling this eventvoid drawLine(Point start, Point end, int width, 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(String uri, Rectangle rect) throws IFException
uri
- the image's URIrect
- the rectangle in which the image shall be paintedIFException
- if an error occurs while handling this eventvoid drawImage(Document doc, Rectangle rect) throws IFException
doc
- the DOM document containing the foreign objectrect
- the rectangle in which the image shall be paintedIFException
- if an error occurs while handling this eventCopyright © 2025 Apache Software Foundation. All rights reserved.