## org.apache.poi.hssf.usermodel
Class EscherGraphics2d

    java.lang.Object
      java.awt.Graphics
          java.awt.Graphics2D
              org.apache.poi.hssf.usermodel.EscherGraphics2d

public class EscherGraphics2d
extends java.awt.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 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 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()`.

Author:
  Glen Stampoultzis (glens at apache.org)

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

Method Summary
`void` `addRenderingHints(java.util.Map map)`
`void` `clearRect(int i, int j, int k, int l)`
`void` `clip(java.awt.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)`
`java.awt.Graphics` `create()`
`void` `dispose()`
`void` `draw(java.awt.Shape shape)`
`void` `drawArc(int x, int y, int width, int height, int startAngle, int arcAngle)`
`void` `drawGlyphVector(java.awt.font.GlyphVector g, float x, float y)`
`void` `drawImage(java.awt.image.BufferedImage bufferedimage, java.awt.image.BufferedImageOp op, int x, int y)`
`boolean` `drawImage(java.awt.Image image, java.awt.geom.AffineTransform affinetransform, java.awt.image.ImageObserver imageobserver)`
`boolean` `drawImage(java.awt.Image image, int x, int y, java.awt.Color bgColor, java.awt.image.ImageObserver imageobserver)`
`boolean` `drawImage(java.awt.Image image, int x, int y, java.awt.image.ImageObserver imageobserver)`
`boolean` `drawImage(java.awt.Image image, int dx1, int dy1, int dx2, int dy2, java.awt.Color bgColor, java.awt.image.ImageObserver imageobserver)`
`boolean` `drawImage(java.awt.Image img, int x, int y, int width, int height, java.awt.image.ImageObserver observer)`
`boolean` `drawImage(java.awt.Image image, int dx1, int dy1, int dx2, int dy2, int sx1, int sy1, int sx2, int sy2, java.awt.Color bgColor, java.awt.image.ImageObserver imageobserver)`
`boolean` `drawImage(java.awt.Image image, int dx1, int dy1, int dx2, int dy2, int sx1, int sy1, int sx2, int sy2, java.awt.image.ImageObserver imageobserver)`
`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` `drawRenderableImage(java.awt.image.renderable.RenderableImage renderableimage, java.awt.geom.AffineTransform affinetransform)`
`void` `drawRenderedImage(java.awt.image.RenderedImage renderedimage, java.awt.geom.AffineTransform affinetransform)`
`void` `drawRoundRect(int i, int j, int k, int l, int i1, int j1)`
`void` `drawString(java.text.AttributedCharacterIterator attributedcharacteriterator, float x, float y)`
`void` `drawString(java.text.AttributedCharacterIterator attributedcharacteriterator, int x, int y)`
`void` `drawString(java.lang.String string, float x, float y)`
`void` `drawString(java.lang.String string, int x, int y)`
`void` `fill(java.awt.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 defined by arrays of 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)`
`java.awt.Color` `getBackground()`
`java.awt.Shape` `getClip()`
`java.awt.Rectangle` `getClipBounds()`
`java.awt.Color` `getColor()`
`java.awt.Composite` `getComposite()`
`java.awt.GraphicsConfiguration` `getDeviceConfiguration()`
`java.awt.Font` `getFont()`
`java.awt.FontMetrics` `getFontMetrics(java.awt.Font font)`
`java.awt.font.FontRenderContext` `getFontRenderContext()`
`java.awt.Paint` `getPaint()`
`java.lang.Object` `getRenderingHint(java.awt.RenderingHints.Key key)`
`java.awt.RenderingHints` `getRenderingHints()`
`java.awt.Stroke` `getStroke()`
`java.awt.geom.AffineTransform` `getTransform()`
`boolean` `hit(java.awt.Rectangle rectangle, java.awt.Shape shape, boolean flag)`
`void` `rotate(double d)`
`void` `rotate(double d, double d1, double d2)`
`void` `scale(double d, double d1)`
`void` `setBackground(java.awt.Color c)`
`void` `setClip(int i, int j, int k, int l)`
`void` `setClip(java.awt.Shape shape)`
`void` `setColor(java.awt.Color c)`
`void` `setComposite(java.awt.Composite composite)`
`void` `setFont(java.awt.Font font)`
`void` `setPaint(java.awt.Paint paint1)`
`void` `setPaintMode()`
`void` `setRenderingHint(java.awt.RenderingHints.Key key, java.lang.Object obj)`
`void` `setRenderingHints(java.util.Map map)`
`void` `setStroke(java.awt.Stroke s)`
`void` `setTransform(java.awt.geom.AffineTransform affinetransform)`
`void` `setXORMode(java.awt.Color color1)`
`void` `shear(double d, double d1)`
`void` `transform(java.awt.geom.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(java.util.Map map)

### clearRect

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

### clip

    public void clip(java.awt.Shape shape)

### clipRect

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

### copyArea

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

### create

    public java.awt.Graphics create()

### dispose

    public void dispose()

### draw

    public void draw(java.awt.Shape shape)

### drawArc

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

### drawGlyphVector

    public void drawGlyphVector(java.awt.font.GlyphVector g,
                                float x,
                                float y)

### drawImage

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

### drawImage

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

### drawImage

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

### drawImage

    public boolean drawImage(java.awt.Image img,
                             int x,
                             int y,
                             int width,
                             int height,
                             java.awt.image.ImageObserver observer)

### drawImage

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

### drawImage

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

### drawImage

    public boolean drawImage(java.awt.Image image,
                             java.awt.geom.AffineTransform affinetransform,
                             java.awt.image.ImageObserver imageobserver)

### drawImage

    public void drawImage(java.awt.image.BufferedImage bufferedimage,
                          java.awt.image.BufferedImageOp op,
                          int x,
                          int y)

### drawLine

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

### drawOval

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

### drawPolygon

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

### drawPolyline

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

### drawRect

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

### drawRenderableImage

    public void drawRenderableImage(java.awt.image.renderable.RenderableImage renderableimage,
                                    java.awt.geom.AffineTransform affinetransform)

### drawRenderedImage

    public void drawRenderedImage(java.awt.image.RenderedImage renderedimage,
                                  java.awt.geom.AffineTransform affinetransform)

### drawRoundRect

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

### drawString

    public void drawString(java.lang.String string,
                           float x,
                           float y)

### drawString

    public void drawString(java.lang.String string,
                           int x,
                           int y)

### drawString

    public void drawString(java.text.AttributedCharacterIterator attributedcharacteriterator,
                           float x,
                           float y)

### drawString

    public void drawString(java.text.AttributedCharacterIterator attributedcharacteriterator,
                           int x,
                           int y)

### fill

    public void fill(java.awt.Shape shape)

### fillArc

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

### 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 defined by arrays of x and y coordinates.

  This method draws the polygon defined by `nPoint` line segments, where the first `nPoint - 1` line segments are line segments from `(xPoints[i - 1], yPoints[i - 1])` to `(xPoints[i], yPoints[i])`, for 1 ≤ i ≤ `nPoints`. The figure is automatically closed by drawing a line connecting the final point to the first point, if those points are different.

  The area inside the polygon is defined using an even-odd fill rule, also known as the alternating rule.

  Parameters:
    `xPoints` - a an array of `x` coordinates.
    `yPoints` - a an array of `y` coordinates.
    `nPoints` - a the total number of points.
  See Also:
    `Graphics.drawPolygon(int[], int[], int)`

### 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)

### getBackground

    public java.awt.Color getBackground()

### getClip

    public java.awt.Shape getClip()

### getClipBounds

    public java.awt.Rectangle getClipBounds()

### getColor

    public java.awt.Color getColor()

### getComposite

    public java.awt.Composite getComposite()

### getDeviceConfiguration

    public java.awt.GraphicsConfiguration getDeviceConfiguration()

### getFont

    public java.awt.Font getFont()

### getFontMetrics

    public java.awt.FontMetrics getFontMetrics(java.awt.Font font)

### getFontRenderContext

    public java.awt.font.FontRenderContext getFontRenderContext()

### getPaint

    public java.awt.Paint getPaint()

### getRenderingHint

    public java.lang.Object getRenderingHint(java.awt.RenderingHints.Key key)

### getRenderingHints

    public java.awt.RenderingHints getRenderingHints()

### getStroke

    public java.awt.Stroke getStroke()

### getTransform

    public java.awt.geom.AffineTransform getTransform()

### hit

    public boolean hit(java.awt.Rectangle rectangle,
                       java.awt.Shape shape,
                       boolean flag)

### rotate

    public void rotate(double d)

### rotate

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

### scale

    public void scale(double d,
                      double d1)

### setBackground

    public void setBackground(java.awt.Color c)

### setClip

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

### setClip

    public void setClip(java.awt.Shape shape)

### setColor

    public void setColor(java.awt.Color c)

### setComposite

    public void setComposite(java.awt.Composite composite)

### setFont

    public void setFont(java.awt.Font font)

### setPaint

    public void setPaint(java.awt.Paint paint1)

### setPaintMode

    public void setPaintMode()

### setRenderingHint

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

### setRenderingHints

    public void setRenderingHints(java.util.Map map)

### setStroke

    public void setStroke(java.awt.Stroke s)

### setTransform

    public void setTransform(java.awt.geom.AffineTransform affinetransform)

### setXORMode

    public void setXORMode(java.awt.Color color1)

### shear

    public void shear(double d,
                      double d1)

### transform

    public void transform(java.awt.geom.AffineTransform affinetransform)

### translate

    public void translate(double d,
                          double d1)

### translate

    public void translate(int i,
                          int j)

Copyright © 2003 Apache Software Foundation.