|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.awt.Graphics
org.apache.poi.hssf.usermodel.EscherGraphics
Translates Graphics 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 performed 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 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 | |
EscherGraphics(HSSFShapeGroup escherGroup,
HSSFWorkbook workbook,
java.awt.Color forecolor,
float verticalPointsPerPixel)
Construct an escher graphics object. |
Method Summary | |
void |
clearRect(int x,
int y,
int width,
int height)
Constructs an escher graphics object. |
void |
clipRect(int x,
int y,
int width,
int height)
|
void |
copyArea(int x,
int y,
int width,
int height,
int dx,
int dy)
|
java.awt.Graphics |
create()
|
void |
dispose()
|
void |
drawArc(int x,
int y,
int width,
int height,
int startAngle,
int arcAngle)
|
boolean |
drawImage(java.awt.Image image,
int i,
int j,
java.awt.Color color,
java.awt.image.ImageObserver imageobserver)
|
boolean |
drawImage(java.awt.Image image,
int i,
int j,
java.awt.image.ImageObserver imageobserver)
|
boolean |
drawImage(java.awt.Image image,
int i,
int j,
int k,
int l,
java.awt.Color color,
java.awt.image.ImageObserver imageobserver)
|
boolean |
drawImage(java.awt.Image image,
int i,
int j,
int k,
int l,
java.awt.image.ImageObserver imageobserver)
|
boolean |
drawImage(java.awt.Image img,
int dx1,
int dy1,
int dx2,
int dy2,
int sx1,
int sy1,
int sx2,
int sy2,
java.awt.Color bgcolor,
java.awt.image.ImageObserver observer)
|
boolean |
drawImage(java.awt.Image img,
int dx1,
int dy1,
int dx2,
int dy2,
int sx1,
int sy1,
int sx2,
int sy2,
java.awt.image.ImageObserver observer)
|
void |
drawLine(int x1,
int y1,
int x2,
int y2)
|
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(java.text.AttributedCharacterIterator iterator,
int x,
int y)
|
void |
drawString(java.lang.String str,
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)
|
void |
fillRect(int x,
int y,
int width,
int height)
|
void |
fillRoundRect(int x,
int y,
int width,
int height,
int arcWidth,
int arcHeight)
|
java.awt.Color |
getBackground()
|
java.awt.Shape |
getClip()
|
java.awt.Rectangle |
getClipBounds()
|
java.awt.Rectangle |
getClipRect()
|
java.awt.Color |
getColor()
|
java.awt.Font |
getFont()
|
java.awt.FontMetrics |
getFontMetrics(java.awt.Font f)
|
void |
setBackground(java.awt.Color background)
|
void |
setClip(int x,
int y,
int width,
int height)
|
void |
setClip(java.awt.Shape shape)
|
void |
setColor(java.awt.Color color)
|
void |
setFont(java.awt.Font f)
|
void |
setPaintMode()
|
void |
setXORMode(java.awt.Color color)
|
void |
translate(int x,
int y)
|
Methods inherited from class java.awt.Graphics |
create, draw3DRect, drawBytes, drawChars, drawPolygon, fill3DRect, fillPolygon, finalize, getClipBounds, getFontMetrics, hitClip, toString |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public EscherGraphics(HSSFShapeGroup escherGroup, HSSFWorkbook workbook, java.awt.Color forecolor, float verticalPointsPerPixel)
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 Detail |
public void clearRect(int x, int y, int width, int height)
public void clipRect(int x, int y, int width, int height)
public void copyArea(int x, int y, int width, int height, int dx, int dy)
public java.awt.Graphics create()
public void dispose()
public void drawArc(int x, int y, int width, int height, int startAngle, int arcAngle)
public boolean drawImage(java.awt.Image img, int dx1, int dy1, int dx2, int dy2, int sx1, int sy1, int sx2, int sy2, java.awt.Color bgcolor, java.awt.image.ImageObserver observer)
public boolean drawImage(java.awt.Image img, int dx1, int dy1, int dx2, int dy2, int sx1, int sy1, int sx2, int sy2, java.awt.image.ImageObserver observer)
public boolean drawImage(java.awt.Image image, int i, int j, int k, int l, java.awt.Color color, java.awt.image.ImageObserver imageobserver)
public boolean drawImage(java.awt.Image image, int i, int j, int k, int l, java.awt.image.ImageObserver imageobserver)
public boolean drawImage(java.awt.Image image, int i, int j, java.awt.Color color, java.awt.image.ImageObserver imageobserver)
public boolean drawImage(java.awt.Image image, int i, int j, java.awt.image.ImageObserver imageobserver)
public void drawLine(int x1, int y1, int x2, int y2)
public void drawOval(int x, int y, int width, int height)
public void drawPolygon(int[] xPoints, int[] yPoints, int nPoints)
public void drawPolyline(int[] xPoints, int[] yPoints, int nPoints)
public void drawRect(int x, int y, int width, int height)
public void drawRoundRect(int x, int y, int width, int height, int arcWidth, int arcHeight)
public void drawString(java.lang.String str, int x, int y)
public void drawString(java.text.AttributedCharacterIterator iterator, int x, int y)
public void fillArc(int x, int y, int width, int height, int startAngle, int arcAngle)
public void fillOval(int x, int y, int width, int height)
public void fillPolygon(int[] xPoints, int[] yPoints, int nPoints)
public void fillRect(int x, int y, int width, int height)
public void fillRoundRect(int x, int y, int width, int height, int arcWidth, int arcHeight)
public java.awt.Shape getClip()
public java.awt.Rectangle getClipBounds()
public java.awt.Rectangle getClipRect()
public java.awt.Color getColor()
public java.awt.Font getFont()
public java.awt.FontMetrics getFontMetrics(java.awt.Font f)
public void setClip(int x, int y, int width, int height)
public void setClip(java.awt.Shape shape)
public void setColor(java.awt.Color color)
public void setFont(java.awt.Font f)
public void setPaintMode()
public void setXORMode(java.awt.Color color)
public void translate(int x, int y)
public java.awt.Color getBackground()
public void setBackground(java.awt.Color background)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |