Package org.apache.poi.hssf.usermodel

Class EscherGraphics2d

java.lang.Object

java.awt.Graphics

java.awt.Graphics2D

org.apache.poi.hssf.usermodel.EscherGraphics2d

public final class EscherGraphics2d
extends Graphics2D

Translates Graphics2d calls into escher calls. The translation is lossy so many features are not supported and some just aren't implemented yet. If in doubt test the specific calls you wish to make. Graphics calls are always drawn into an EscherGroup so one will need to be created.

Important:

One important concept worth considering is that of font size. One of the difficulties in converting Graphics calls into escher drawing calls is that Excel does not have the concept of absolute pixel positions. It measures its cell widths in 'characters' and the cell heights in points. Unfortunately it's not defined exactly what a type of character it's measuring. Presumably this is due to the fact that the Excel will be using different fonts on different platforms or even within the same platform.

Because of this constraint you have to calculate the verticalPointsPerPixel. This the amount the font should be scaled by when you issue commands such as drawString(). A good way to calculate this is to use the follow formula:

      multipler = groupHeightInPoints / heightOfGroup
 

The height of the group is calculated fairly simply by calculating the difference between the y coordinates of the bounding box of the shape. The height of the group can be calculated by using a convenience called HSSFClientAnchor.getAnchorHeightInPoints().

Constructor Summary

Constructors

Constructor	Description
EscherGraphics2d(EscherGraphics escherGraphics)	Constructs one escher graphics object from an escher graphics object.

Method Summary

Modifier and Type	Method	Description
void	addRenderingHints(Map<?,?> map)
void	clearRect(int i, int j, int k, int l)
void	clip(Shape shape)
void	clipRect(int x, int y, int width, int height)
void	copyArea(int x, int y, int width, int height, int dx, int dy)
Graphics	create()
void	dispose()
void	draw(Shape shape)
void	drawArc(int x, int y, int width, int height, int startAngle, int arcAngle)
void	drawGlyphVector(GlyphVector g, float x, float y)
void	drawImage(BufferedImage bufferedimage, BufferedImageOp op, int x, int y)
boolean	drawImage(Image image, int dx1, int dy1, int dx2, int dy2, int sx1, int sy1, int sx2, int sy2, Color bgColor, ImageObserver imageobserver)
boolean	drawImage(Image image, int dx1, int dy1, int dx2, int dy2, int sx1, int sy1, int sx2, int sy2, ImageObserver imageobserver)
boolean	drawImage(Image image, int dx1, int dy1, int dx2, int dy2, Color bgColor, ImageObserver imageobserver)
boolean	drawImage(Image img, int x, int y, int width, int height, ImageObserver observer)
boolean	drawImage(Image image, int x, int y, Color bgColor, ImageObserver imageobserver)
boolean	drawImage(Image image, int x, int y, ImageObserver imageobserver)
boolean	drawImage(Image image, AffineTransform affinetransform, ImageObserver imageobserver)
void	drawLine(int x1, int y1, int x2, int y2)
void	drawLine(int x1, int y1, int x2, int y2, int width)
void	drawOval(int x, int y, int width, int height)
void	drawPolygon(int[] xPoints, int[] yPoints, int nPoints)
void	drawPolyline(int[] xPoints, int[] yPoints, int nPoints)
void	drawRect(int x, int y, int width, int height)
void	drawRenderableImage(RenderableImage renderableimage, AffineTransform affinetransform)
void	drawRenderedImage(RenderedImage renderedimage, AffineTransform affinetransform)
void	drawRoundRect(int i, int j, int k, int l, int i1, int j1)
void	drawString(String string, float x, float y)
void	drawString(String string, int x, int y)
void	drawString(AttributedCharacterIterator attributedcharacteriterator, float x, float y)
void	drawString(AttributedCharacterIterator attributedcharacteriterator, int x, int y)
void	fill(Shape shape)
void	fillArc(int i, int j, int k, int l, int i1, int j1)
void	fillOval(int x, int y, int width, int height)
void	fillPolygon(int[] xPoints, int[] yPoints, int nPoints)	Fills a (closed) polygon, as defined by a pair of arrays, which hold the x and y coordinates.
void	fillRect(int x, int y, int width, int height)
void	fillRoundRect(int x, int y, int width, int height, int arcWidth, int arcHeight)
Color	getBackground()
Shape	getClip()
Rectangle	getClipBounds()
Color	getColor()
Composite	getComposite()
GraphicsConfiguration	getDeviceConfiguration()
Font	getFont()
FontMetrics	getFontMetrics(Font font)
FontRenderContext	getFontRenderContext()
Paint	getPaint()
Object	getRenderingHint(RenderingHints.Key key)
RenderingHints	getRenderingHints()
Stroke	getStroke()
AffineTransform	getTransform()
boolean	hit(Rectangle rectangle, Shape shape, boolean flag)
void	rotate(double d)
void	rotate(double d, double d1, double d2)
void	scale(double d, double d1)
void	setBackground(Color c)
void	setClip(int i, int j, int k, int l)
void	setClip(Shape shape)
void	setColor(Color c)
void	setComposite(Composite composite)
void	setFont(Font font)
void	setPaint(Paint paint1)
void	setPaintMode()
void	setRenderingHint(RenderingHints.Key key, Object obj)
void	setRenderingHints(Map<?,?> map)
void	setStroke(Stroke s)
void	setTransform(AffineTransform affinetransform)
void	setXORMode(Color color1)
void	shear(double d, double d1)
void	transform(AffineTransform affinetransform)
void	translate(double d, double d1)
void	translate(int i, int j)

Methods inherited from class java.awt.Graphics2D

draw3DRect, fill3DRect

Methods inherited from class java.awt.Graphics

create, drawBytes, drawChars, drawPolygon, fillPolygon, finalize, getClipBounds, getClipRect, getFontMetrics, hitClip, toString

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EscherGraphics2d

public EscherGraphics2d(EscherGraphics escherGraphics)

Constructs one escher graphics object from an escher graphics object.

Parameters:

escherGraphics - the original EscherGraphics2d object to copy

Method Detail

addRenderingHints

public void addRenderingHints(Map<?,?> map)

Specified by:

addRenderingHints in class Graphics2D

clearRect

public void clearRect(int i,
                      int j,
                      int k,
                      int l)

Specified by:

clearRect in class Graphics

clip

public void clip(Shape shape)

Specified by:

clip in class Graphics2D

clipRect

public void clipRect(int x,
                     int y,
                     int width,
                     int height)

Specified by:

clipRect in class Graphics

copyArea

public void copyArea(int x,
                     int y,
                     int width,
                     int height,
                     int dx,
                     int dy)

Specified by:

copyArea in class Graphics

create

public Graphics create()

Specified by:

create in class Graphics

dispose

public void dispose()

Specified by:

dispose in class Graphics

draw

public void draw(Shape shape)

Specified by:

draw in class Graphics2D

drawArc

public void drawArc(int x,
                    int y,
                    int width,
                    int height,
                    int startAngle,
                    int arcAngle)

Specified by:

drawArc in class Graphics

drawGlyphVector

public void drawGlyphVector(GlyphVector g,
                            float x,
                            float y)

Specified by:

drawGlyphVector in class Graphics2D

drawImage

public boolean drawImage(Image image,
                         int dx1,
                         int dy1,
                         int dx2,
                         int dy2,
                         int sx1,
                         int sy1,
                         int sx2,
                         int sy2,
                         Color bgColor,
                         ImageObserver imageobserver)

Specified by:

drawImage in class Graphics

drawImage

public boolean drawImage(Image image,
                         int dx1,
                         int dy1,
                         int dx2,
                         int dy2,
                         int sx1,
                         int sy1,
                         int sx2,
                         int sy2,
                         ImageObserver imageobserver)

Specified by:

drawImage in class Graphics

drawImage

public boolean drawImage(Image image,
                         int dx1,
                         int dy1,
                         int dx2,
                         int dy2,
                         Color bgColor,
                         ImageObserver imageobserver)

Specified by:

drawImage in class Graphics

drawImage

public boolean drawImage(Image img,
                         int x,
                         int y,
                         int width,
                         int height,
                         ImageObserver observer)

Specified by:

drawImage in class Graphics

drawImage

public boolean drawImage(Image image,
                         int x,
                         int y,
                         Color bgColor,
                         ImageObserver imageobserver)

Specified by:

drawImage in class Graphics

drawImage

public boolean drawImage(Image image,
                         int x,
                         int y,
                         ImageObserver imageobserver)

Specified by:

drawImage in class Graphics

drawImage

public boolean drawImage(Image image,
                         AffineTransform affinetransform,
                         ImageObserver imageobserver)

Specified by:

drawImage in class Graphics2D

drawImage

public void drawImage(BufferedImage bufferedimage,
                      BufferedImageOp op,
                      int x,
                      int y)

Specified by:

drawImage in class Graphics2D

drawLine

public void drawLine(int x1,
                     int y1,
                     int x2,
                     int y2,
                     int width)

drawLine

public void drawLine(int x1,
                     int y1,
                     int x2,
                     int y2)

Specified by:

drawLine in class Graphics

drawOval

public void drawOval(int x,
                     int y,
                     int width,
                     int height)

Specified by:

drawOval in class Graphics

drawPolygon

public void drawPolygon(int[] xPoints,
                        int[] yPoints,
                        int nPoints)

Specified by:

drawPolygon in class Graphics

drawPolyline

public void drawPolyline(int[] xPoints,
                         int[] yPoints,
                         int nPoints)

Specified by:

drawPolyline in class Graphics

drawRect

public void drawRect(int x,
                     int y,
                     int width,
                     int height)

Overrides:

drawRect in class Graphics

drawRenderableImage

public void drawRenderableImage(RenderableImage renderableimage,
                                AffineTransform affinetransform)

Specified by:

drawRenderableImage in class Graphics2D

drawRenderedImage

public void drawRenderedImage(RenderedImage renderedimage,
                              AffineTransform affinetransform)

Specified by:

drawRenderedImage in class Graphics2D

drawRoundRect

public void drawRoundRect(int i,
                          int j,
                          int k,
                          int l,
                          int i1,
                          int j1)

Specified by:

drawRoundRect in class Graphics

drawString

public void drawString(String string,
                       float x,
                       float y)

Specified by:

drawString in class Graphics2D

drawString

public void drawString(String string,
                       int x,
                       int y)

Specified by:

drawString in class Graphics2D

drawString

public void drawString(AttributedCharacterIterator attributedcharacteriterator,
                       float x,
                       float y)

Specified by:

drawString in class Graphics2D

drawString

public void drawString(AttributedCharacterIterator attributedcharacteriterator,
                       int x,
                       int y)

Specified by:

drawString in class Graphics2D

fill

public void fill(Shape shape)

Specified by:

fill in class Graphics2D

fillArc

public void fillArc(int i,
                    int j,
                    int k,
                    int l,
                    int i1,
                    int j1)

Specified by:

fillArc in class Graphics

fillOval

public void fillOval(int x,
                     int y,
                     int width,
                     int height)

Specified by:

fillOval in class Graphics

fillPolygon

public void fillPolygon(int[] xPoints,
                        int[] yPoints,
                        int nPoints)

Fills a (closed) polygon, as defined by a pair of arrays, which hold the x and y coordinates.

This draws the polygon, with nPoint line segments. The first nPoint - 1 line segments are drawn between sequential points (xPoints[i],yPoints[i],xPoints[i+1],yPoints[i+1]). The final line segment is a closing one, from the last point to the first (assuming they are different).

The area inside of the polygon is defined by using an even-odd fill rule (also known as the alternating rule), and the area inside of it is filled.

Specified by:

fillPolygon in class Graphics

Parameters:

xPoints - array of the x coordinates.

yPoints - array of the y coordinates.

nPoints - the total number of points in the polygon.

See Also:

Graphics.drawPolygon(int[], int[], int)

fillRect

public void fillRect(int x,
                     int y,
                     int width,
                     int height)

Specified by:

fillRect in class Graphics

fillRoundRect

public void fillRoundRect(int x,
                          int y,
                          int width,
                          int height,
                          int arcWidth,
                          int arcHeight)

Specified by:

fillRoundRect in class Graphics

getBackground

public Color getBackground()

Specified by:

getBackground in class Graphics2D

getClip

public Shape getClip()

Specified by:

getClip in class Graphics

getClipBounds

public Rectangle getClipBounds()

Specified by:

getClipBounds in class Graphics

getColor

public Color getColor()

Specified by:

getColor in class Graphics

getComposite

public Composite getComposite()

Specified by:

getComposite in class Graphics2D

getDeviceConfiguration

public GraphicsConfiguration getDeviceConfiguration()

Specified by:

getDeviceConfiguration in class Graphics2D

getFont

public Font getFont()

Specified by:

getFont in class Graphics

getFontMetrics

public FontMetrics getFontMetrics(Font font)

Specified by:

getFontMetrics in class Graphics

getFontRenderContext

public FontRenderContext getFontRenderContext()

Specified by:

getFontRenderContext in class Graphics2D

getPaint

public Paint getPaint()

Specified by:

getPaint in class Graphics2D

getRenderingHint

public Object getRenderingHint(RenderingHints.Key key)

Specified by:

getRenderingHint in class Graphics2D

getRenderingHints

public RenderingHints getRenderingHints()

Specified by:

getRenderingHints in class Graphics2D

getStroke

public Stroke getStroke()

Specified by:

getStroke in class Graphics2D

getTransform

public AffineTransform getTransform()

Specified by:

getTransform in class Graphics2D

hit

public boolean hit(Rectangle rectangle,
                   Shape shape,
                   boolean flag)

Specified by:

hit in class Graphics2D

rotate

public void rotate(double d)

Specified by:

rotate in class Graphics2D

rotate

public void rotate(double d,
                   double d1,
                   double d2)

Specified by:

rotate in class Graphics2D

scale

public void scale(double d,
                  double d1)

Specified by:

scale in class Graphics2D

setBackground

public void setBackground(Color c)

Specified by:

setBackground in class Graphics2D

setClip

public void setClip(int i,
                    int j,
                    int k,
                    int l)

Specified by:

setClip in class Graphics

setClip

public void setClip(Shape shape)

Specified by:

setClip in class Graphics

setColor

public void setColor(Color c)

Specified by:

setColor in class Graphics

setComposite

public void setComposite(Composite composite)

Specified by:

setComposite in class Graphics2D

setFont

public void setFont(Font font)

Specified by:

setFont in class Graphics

setPaint

public void setPaint(Paint paint1)

Specified by:

setPaint in class Graphics2D

setPaintMode

public void setPaintMode()

Specified by:

setPaintMode in class Graphics

setRenderingHint

public void setRenderingHint(RenderingHints.Key key,
                             Object obj)

Specified by:

setRenderingHint in class Graphics2D

setRenderingHints

public void setRenderingHints(Map<?,?> map)

Specified by:

setRenderingHints in class Graphics2D

setStroke

public void setStroke(Stroke s)

Specified by:

setStroke in class Graphics2D

setTransform

public void setTransform(AffineTransform affinetransform)

Specified by:

setTransform in class Graphics2D

setXORMode

public void setXORMode(Color color1)

Specified by:

setXORMode in class Graphics

shear

public void shear(double d,
                  double d1)

Specified by:

shear in class Graphics2D

transform

public void transform(AffineTransform affinetransform)

Specified by:

transform in class Graphics2D

translate

public void translate(double d,
                      double d1)

Specified by:

translate in class Graphics2D

translate

public void translate(int i,
                      int j)

Specified by:

translate in class Graphics2D