Class EscherGraphics
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 it's 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 we've had 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 / heightOfGroupThe 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
ConstructorsConstructorDescriptionEscherGraphics
(HSSFShapeGroup escherGroup, HSSFWorkbook workbook, Color forecolor, float verticalPointsPerPixel) Construct an escher graphics object. -
Method Summary
Modifier and TypeMethodDescriptionvoid
clearRect
(int x, int y, int width, int height) void
clipRect
(int x, int y, int width, int height) void
copyArea
(int x, int y, int width, int height, int dx, int dy) create()
void
dispose()
void
drawArc
(int x, int y, int width, int height, int startAngle, int arcAngle) boolean
drawImage
(Image img, int dx1, int dy1, int dx2, int dy2, int sx1, int sy1, int sx2, int sy2, Color bgcolor, ImageObserver observer) boolean
drawImage
(Image img, int dx1, int dy1, int dx2, int dy2, int sx1, int sy1, int sx2, int sy2, ImageObserver observer) boolean
drawImage
(Image image, int i, int j, int k, int l, Color color, ImageObserver imageobserver) boolean
drawImage
(Image image, int i, int j, int k, int l, ImageObserver imageobserver) boolean
drawImage
(Image image, int i, int j, Color color, ImageObserver imageobserver) boolean
drawImage
(Image image, int i, int j, 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
drawRoundRect
(int x, int y, int width, int height, int arcWidth, int arcHeight) void
drawString
(String str, int x, int y) void
drawString
(AttributedCharacterIterator iterator, int x, int y) void
fillArc
(int x, int y, int width, int height, int startAngle, int arcAngle) 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) getClip()
getColor()
getFont()
void
setBackground
(Color background) void
setClip
(int x, int y, int width, int height) void
void
void
void
void
setXORMode
(Color color) void
translate
(int x, int y) Methods inherited from class java.awt.Graphics
create, draw3DRect, drawBytes, drawChars, drawPolygon, fill3DRect, fillPolygon, finalize, getClipBounds, getClipRect, getFontMetrics, hitClip, toString
-
Constructor Details
-
EscherGraphics
public EscherGraphics(HSSFShapeGroup escherGroup, HSSFWorkbook workbook, Color forecolor, float verticalPointsPerPixel) Construct an escher graphics object.- Parameters:
escherGroup
- The escher group to write the graphics calls into.workbook
- The workbook we are using.forecolor
- The foreground color to use as default.verticalPointsPerPixel
- The font multiplier. (See class description for information on how this works.).
-
-
Method Details
-
clearRect
-
clipRect
-
copyArea
-
create
-
dispose
public void dispose() -
drawArc
@NotImplemented public void drawArc(int x, int y, int width, int height, int startAngle, int arcAngle) -
drawImage
@NotImplemented public boolean drawImage(Image img, int dx1, int dy1, int dx2, int dy2, int sx1, int sy1, int sx2, int sy2, Color bgcolor, ImageObserver observer) -
drawImage
@NotImplemented public boolean drawImage(Image img, int dx1, int dy1, int dx2, int dy2, int sx1, int sy1, int sx2, int sy2, ImageObserver observer) -
drawImage
public boolean drawImage(Image image, int i, int j, int k, int l, Color color, ImageObserver imageobserver) -
drawImage
-
drawImage
-
drawImage
-
drawLine
public void drawLine(int x1, int y1, int x2, int y2) -
drawLine
public void drawLine(int x1, int y1, int x2, int y2, int width) -
drawOval
public void drawOval(int x, int y, int width, int height) -
drawPolygon
public void drawPolygon(int[] xPoints, int[] yPoints, int nPoints) - Specified by:
drawPolygon
in classGraphics
-
drawPolyline
- Specified by:
drawPolyline
in classGraphics
-
drawRect
-
drawRoundRect
@NotImplemented public void drawRoundRect(int x, int y, int width, int height, int arcWidth, int arcHeight) - Specified by:
drawRoundRect
in classGraphics
-
drawString
- Specified by:
drawString
in classGraphics
-
drawString
- Specified by:
drawString
in classGraphics
-
fillArc
public void fillArc(int x, int y, int width, int height, int startAngle, int arcAngle) -
fillOval
public void fillOval(int x, int y, int width, int height) -
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 firstnPoint - 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 classGraphics
- Parameters:
xPoints
- array of thex
coordinates.yPoints
- array of they
coordinates.nPoints
- the total number of points in the polygon.- See Also:
-
fillRect
public void fillRect(int x, int y, int width, int height) -
fillRoundRect
public void fillRoundRect(int x, int y, int width, int height, int arcWidth, int arcHeight) - Specified by:
fillRoundRect
in classGraphics
-
getClip
-
getClipBounds
- Specified by:
getClipBounds
in classGraphics
-
getColor
-
getFont
-
getFontMetrics
- Specified by:
getFontMetrics
in classGraphics
-
setClip
public void setClip(int x, int y, int width, int height) -
setClip
-
setColor
-
setFont
-
setPaintMode
- Specified by:
setPaintMode
in classGraphics
-
setXORMode
- Specified by:
setXORMode
in classGraphics
-
translate
-
getBackground
-
setBackground
-