fop 1.0

org.apache.fop.render.java2d
Class Java2DPainter

java.lang.Object
  extended by org.apache.fop.render.intermediate.AbstractIFPainter
      extended by org.apache.fop.render.java2d.Java2DPainter
All Implemented Interfaces:
IFPainter

public class Java2DPainter
extends AbstractIFPainter

IFPainter implementation that paints on a Graphics2D instance.


Field Summary
protected  FontInfo fontInfo
          The font information
protected  Java2DGraphicsState g2dState
          The current state, holds a Graphics2D and its context
protected  IFContext ifContext
          the IF context
 
Fields inherited from class org.apache.fop.render.intermediate.AbstractIFPainter
INSTREAM_OBJECT_URI, state
 
Constructor Summary
Java2DPainter(java.awt.Graphics2D g2d, IFContext context, FontInfo fontInfo)
          Main constructor.
Java2DPainter(java.awt.Graphics2D g2d, IFContext context, FontInfo fontInfo, IFState state)
          Special constructor for embedded use (when another painter uses Java2DPainter to convert part of a document into a bitmap, for example).
 
Method Summary
 void clipRect(java.awt.Rectangle rect)
          Restricts the current clipping region with the given rectangle.
protected  RenderingContext createRenderingContext()
          Creates a new RenderingContext instance.
 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.
 IFContext getContext()
          Returns the intermediate format context object.
protected  FontInfo getFontInfo()
          Returns the associated FontInfo object.
protected  Java2DGraphicsState getState()
          Returns the Java2D graphics state.
protected  void restoreGraphicsState()
          Restores the last graphics state from the stack.
protected  void saveGraphicsState()
          Saves the current graphics state on the stack.
 void startGroup(java.awt.geom.AffineTransform transform)
          Starts a new group of graphical elements.
 void startViewport(java.awt.geom.AffineTransform transform, java.awt.Dimension size, java.awt.Rectangle clipRect)
          Starts a new viewport, establishing a new coordinate system.
 
Methods inherited from class org.apache.fop.render.intermediate.AbstractIFPainter
createDefaultImageProcessingHints, drawImage, drawImage, drawImageUsingDocument, drawImageUsingImageHandler, drawImageUsingURI, getFopFactory, getImageInfo, getLineBoundingBox, getUserAgent, setFont, startGroup, startViewport, toPoints
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ifContext

protected IFContext ifContext
the IF context


fontInfo

protected FontInfo fontInfo
The font information


g2dState

protected Java2DGraphicsState g2dState
The current state, holds a Graphics2D and its context

Constructor Detail

Java2DPainter

public Java2DPainter(java.awt.Graphics2D g2d,
                     IFContext context,
                     FontInfo fontInfo)
Main constructor.

Parameters:
g2d - the target Graphics2D instance
context - the IF context
fontInfo - the font information

Java2DPainter

public Java2DPainter(java.awt.Graphics2D g2d,
                     IFContext context,
                     FontInfo fontInfo,
                     IFState state)
Special constructor for embedded use (when another painter uses Java2DPainter to convert part of a document into a bitmap, for example).

Parameters:
g2d - the target Graphics2D instance
context - the IF context
fontInfo - the font information
state - the IF state object
Method Detail

getContext

public IFContext getContext()
Returns the intermediate format context object.

Specified by:
getContext in class AbstractIFPainter
Returns:
the context object

getFontInfo

protected FontInfo getFontInfo()
Returns the associated FontInfo object.

Returns:
the font info

getState

protected Java2DGraphicsState getState()
Returns the Java2D graphics state.

Returns:
the graphics state

startViewport

public void startViewport(java.awt.geom.AffineTransform transform,
                          java.awt.Dimension size,
                          java.awt.Rectangle clipRect)
                   throws IFException
Starts a new viewport, establishing a new coordinate system. A viewport has a size and can optionally be clipped. Corresponds to SVG's svg element.

Parameters:
transform - the transformation matrix establishing the new coordinate system
size - the size of the viewport
clipRect - the clipping rectangle (may be null)
Throws:
IFException - if an error occurs while handling this element

endViewport

public void endViewport()
                 throws IFException
Ends the current viewport and restores the previous coordinate system.

Throws:
IFException - if an error occurs while handling this element

startGroup

public void startGroup(java.awt.geom.AffineTransform transform)
                throws IFException
Starts a new group of graphical elements. Corresponds to SVG's g element.

Parameters:
transform - the transformation matrix establishing the new coordinate system
Throws:
IFException - if an error occurs while handling this element

endGroup

public void endGroup()
              throws IFException
Ends the current group and restores the previous coordinate system.

Throws:
IFException - if an error occurs while handling this element

drawImage

public void drawImage(java.lang.String uri,
                      java.awt.Rectangle rect)
               throws IFException
Draws an image identified by a URI inside a given rectangle. This is the equivalent to an fo:external-graphic in XSL-FO.

Parameters:
uri - the image's URI
rect - the rectangle in which the image shall be painted
Throws:
IFException - if an error occurs while handling this event

createRenderingContext

protected RenderingContext createRenderingContext()
Creates a new RenderingContext instance.

Specified by:
createRenderingContext in class AbstractIFPainter
Returns:
the new rendering context.

drawImage

public void drawImage(org.w3c.dom.Document doc,
                      java.awt.Rectangle rect)
               throws IFException
Draws an image (represented by a DOM document) inside a given rectangle. This is the equivalent to an fo:instream-foreign-object in XSL-FO.

Parameters:
doc - the DOM document containing the foreign object
rect - the rectangle in which the image shall be painted
Throws:
IFException - if an error occurs while handling this event

clipRect

public void clipRect(java.awt.Rectangle rect)
              throws IFException
Restricts the current clipping region with the given rectangle.

Parameters:
rect - the rectangle's coordinates and extent
Throws:
IFException - if an error occurs while handling this event

fillRect

public void fillRect(java.awt.Rectangle rect,
                     java.awt.Paint fill)
              throws IFException
Fills a rectangular area.

Parameters:
rect - the rectangle's coordinates and extent
fill - the fill paint
Throws:
IFException - if an error occurs while handling this event

drawBorderRect

public void drawBorderRect(java.awt.Rectangle rect,
                           BorderProps before,
                           BorderProps after,
                           BorderProps start,
                           BorderProps end)
                    throws IFException
Draws a border rectangle. The border segments are specified through BorderProps instances.

Specified by:
drawBorderRect in interface IFPainter
Overrides:
drawBorderRect in class AbstractIFPainter
Parameters:
rect - the rectangle's coordinates and extent
before - 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)
Throws:
IFException - if an error occurs while handling this event

drawLine

public void drawLine(java.awt.Point start,
                     java.awt.Point end,
                     int width,
                     java.awt.Color color,
                     RuleStyle style)
              throws IFException
Draws a line. NOTE: Currently, only horizontal lines are implemented!

Specified by:
drawLine in interface IFPainter
Overrides:
drawLine in class AbstractIFPainter
Parameters:
start - the start point of the line
end - the end point of the line
width - the line width
color - the line color
style - the line style (using the Constants.EN_* constants for the rule-style property)
Throws:
IFException - if an error occurs while handling this event

drawText

public void drawText(int x,
                     int y,
                     int letterSpacing,
                     int wordSpacing,
                     int[] dx,
                     java.lang.String text)
              throws IFException
Draws text. The initial coordinates (x and y) point to the starting point at the normal baseline of the font. The parameters letterSpacing, wordSpacing and the array dx are optional and can be used to influence character positioning (for example, for kerning).

Parameters:
x - X-coordinate of the starting point of the text
y - Y-coordinate of the starting point of the text
letterSpacing - 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
Throws:
IFException - if an error occurs while handling this event

saveGraphicsState

protected void saveGraphicsState()
Saves the current graphics state on the stack.


restoreGraphicsState

protected void restoreGraphicsState()
Restores the last graphics state from the stack.


fop 1.0

Copyright 1999-2010 The Apache Software Foundation. All Rights Reserved.