Top Description Fields Constructors Methods
org.apache.poi.hssf.usermodel

public final Class EscherGraphics2d

extends Graphics2D
Class Inheritance
Imports
org.apache.logging.log4j.LogManager, .Logger, java.awt.*, java.awt.font.FontRenderContext, .GlyphVector, .TextLayout, java.awt.geom.AffineTransform, .Arc2D, .Area, .GeneralPath, .Line2D, .RoundRectangle2D, java.awt.image.BufferedImage, .BufferedImageOp, .ImageObserver, .RenderedImage, java.awt.image.renderable.RenderableImage, java.text.AttributedCharacterIterator, java.util.Map
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().

Field Summary

Modifier and TypeField and Description
private Shape
_deviceclip

private final EscherGraphics
_escherGraphics

private BufferedImage
_img

private Paint
_paint

private Stroke
_stroke

private AffineTransform
_trans

private static final Logger
LOG

Constructor Summary

AccessConstructor and Description
public
EscherGraphics2d(EscherGraphics
the original EscherGraphics2d object to copy
escherGraphics)

Constructs one escher graphics object from an escher graphics object.

Method Summary

Modifier and TypeMethod and Description
public void
addRenderingHints(Map<?, ?>
the rendering hints to be set
map)

Implements abstract java.awt.Graphics2D.addRenderingHints.

Sets the values of an arbitrary number of preferences for the rendering algorithms.

public void
clearRect(int
the x coordinate of the rectangle to clear.
i, int
the y coordinate of the rectangle to clear.
j, int
the width of the rectangle to clear.
k, int
the height of the rectangle to clear.
l)

Implements abstract java.awt.Graphics.clearRect.

Clears the specified rectangle by filling it with the background color of the current drawing surface.

public void
clip(Shape
the Shape to be intersected with the current Clip. This method updates the current Clip.
shape)

Implements abstract java.awt.Graphics2D.clip.

Intersects the current Clip with the interior of the specified Shape and sets the Clip to the resulting intersection.

public void
clipRect(int
the x coordinate of the rectangle to intersect the clip with
x, int
the y coordinate of the rectangle to intersect the clip with
y, int
the width of the rectangle to intersect the clip with
width, int
the height of the rectangle to intersect the clip with
height)

Implements abstract java.awt.Graphics.clipRect.

Intersects the current clip with the specified rectangle.

public void
copyArea(int
the x coordinate of the source rectangle.
x, int
the y coordinate of the source rectangle.
y, int
the width of the source rectangle.
width, int
the height of the source rectangle.
height, int
the horizontal distance to copy the pixels.
dx, int
the vertical distance to copy the pixels.
dy)

Implements abstract java.awt.Graphics.copyArea.

Copies an area of the component by a distance specified by dx and dy.

public Graphics
create()

Implements abstract java.awt.Graphics.create.

Creates a new Graphics object that is a copy of this Graphics object.

public void
dispose()

Implements abstract java.awt.Graphics.dispose.

Disposes of this graphics context and releases any system resources that it is using.

public void
draw(Shape
the Shape to be rendered
shape)

Implements abstract java.awt.Graphics2D.draw.

Strokes the outline of a Shape using the settings of the current Graphics2D context.

public void
drawArc(int
the x coordinate of the upper-left corner of the arc to be drawn.
x, int
the y coordinate of the upper-left corner of the arc to be drawn.
y, int
the width of the arc to be drawn.
width, int
the height of the arc to be drawn.
height, int
the beginning angle.
startAngle, int
the angular extent of the arc, relative to the start angle.
arcAngle)

Implements abstract java.awt.Graphics.drawArc.

Draws the outline of a circular or elliptical arc covering the specified rectangle.

public void
drawGlyphVector(GlyphVector
the GlyphVector to be rendered
g, float
the x position in User Space where the glyphs should be rendered
x, float
the y position in User Space where the glyphs should be rendered
y)

Implements abstract java.awt.Graphics2D.drawGlyphVector.

Renders the text of the specified GlyphVector using the Graphics2D context's rendering attributes.

public boolean
drawImage(Image
the specified image to be drawn. This method does nothing if img is null.
image, int
the x coordinate of the first corner of the destination rectangle.
dx1, int
the y coordinate of the first corner of the destination rectangle.
dy1, int
the x coordinate of the second corner of the destination rectangle.
dx2, int
the y coordinate of the second corner of the destination rectangle.
dy2, int
the x coordinate of the first corner of the source rectangle.
sx1, int
the y coordinate of the first corner of the source rectangle.
sy1, int
the x coordinate of the second corner of the source rectangle.
sx2, int
the y coordinate of the second corner of the source rectangle.
sy2, Color
the background color to paint under the non-opaque portions of the image.
bgColor, ImageObserver
object to be notified as more of the image is scaled and converted.
imageobserver)

Implements abstract java.awt.Graphics.drawImage.

Draws as much of the specified area of the specified image as is currently available, scaling it on the fly to fit inside the specified area of the destination drawable surface.

public boolean
drawImage(Image
the specified image to be drawn. This method does nothing if img is null.
image, int
the x coordinate of the first corner of the destination rectangle.
dx1, int
the y coordinate of the first corner of the destination rectangle.
dy1, int
the x coordinate of the second corner of the destination rectangle.
dx2, int
the y coordinate of the second corner of the destination rectangle.
dy2, int
the x coordinate of the first corner of the source rectangle.
sx1, int
the y coordinate of the first corner of the source rectangle.
sy1, int
the x coordinate of the second corner of the source rectangle.
sx2, int
the y coordinate of the second corner of the source rectangle.
sy2, ImageObserver
object to be notified as more of the image is scaled and converted.
imageobserver)

Implements abstract java.awt.Graphics.drawImage.

Draws as much of the specified area of the specified image as is currently available, scaling it on the fly to fit inside the specified area of the destination drawable surface.

public boolean
drawImage(Image
the specified image to be drawn. This method does nothing if img is null.
image, int
the x coordinate.
dx1, int
the y coordinate.
dy1, int
the width of the rectangle.
dx2, int
the height of the rectangle.
dy2, Color
the background color to paint under the non-opaque portions of the image.
bgColor, ImageObserver
object to be notified as more of the image is converted.
imageobserver)

Implements abstract java.awt.Graphics.drawImage.

Draws as much of the specified image as has already been scaled to fit inside the specified rectangle.

public boolean
drawImage(Image
the specified image to be drawn. This method does nothing if img is null.
img, int
the x coordinate.
x, int
the y coordinate.
y, int
the width of the rectangle.
width, int
the height of the rectangle.
height, ImageObserver
object to be notified as more of the image is converted.
observer)

Implements abstract java.awt.Graphics.drawImage.

Draws as much of the specified image as has already been scaled to fit inside the specified rectangle.

public boolean
drawImage(Image
the specified image to be drawn. This method does nothing if img is null.
image, int
the x coordinate.
x, int
the y coordinate.
y, Color
the background color to paint under the non-opaque portions of the image.
bgColor, ImageObserver
object to be notified as more of the image is converted.
imageobserver)

Implements abstract java.awt.Graphics.drawImage.

Draws as much of the specified image as is currently available.

public boolean
drawImage(Image
the specified image to be drawn. This method does nothing if img is null.
image, int
the x coordinate.
x, int
the y coordinate.
y, ImageObserver
object to be notified as more of the image is converted.
imageobserver)

Implements abstract java.awt.Graphics.drawImage.

Draws as much of the specified image as is currently available.

public boolean
drawImage(Image
the specified image to be rendered. This method does nothing if img is null.
image, AffineTransform
the transformation from image space into user space
affinetransform, ImageObserver
the ImageObserver to be notified as more of the Image is converted
imageobserver)

Implements abstract java.awt.Graphics2D.drawImage.

Renders an image, applying a transform from image space into user space before drawing.

public void
drawImage(BufferedImage
the specified BufferedImage to be rendered. This method does nothing if img is null.
bufferedimage, BufferedImageOp
the filter to be applied to the image before rendering
op, int
the x coordinate of the location in user space where the upper left corner of the image is rendered
x, int
the y coordinate of the location in user space where the upper left corner of the image is rendered
y)

Implements abstract java.awt.Graphics2D.drawImage.

Renders a BufferedImage that is filtered with a BufferedImageOp.

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

public void
drawLine(int
the first point's x coordinate.
x1, int
the first point's y coordinate.
y1, int
the second point's x coordinate.
x2, int
the second point's y coordinate.
y2)

Implements abstract java.awt.Graphics.drawLine.

Draws a line, using the current color, between the points (x1, y1) and (x2, y2) in this graphics context's coordinate system.

public void
drawOval(int
the x coordinate of the upper left corner of the oval to be drawn.
x, int
the y coordinate of the upper left corner of the oval to be drawn.
y, int
the width of the oval to be drawn.
width, int
the height of the oval to be drawn.
height)

Implements abstract java.awt.Graphics.drawOval.

Draws the outline of an oval.

public void
drawPolygon(int[]
an array of x coordinates.
xPoints, int[]
an array of y coordinates.
yPoints, int
the total number of points.
nPoints)

Implements abstract java.awt.Graphics.drawPolygon.

Draws a closed polygon defined by arrays of x and y coordinates.

public void
drawPolyline(int[]
an array of x points
xPoints, int[]
an array of y points
yPoints, int
the total number of points
nPoints)

Implements abstract java.awt.Graphics.drawPolyline.

Draws a sequence of connected lines defined by arrays of x and y coordinates.

public void
drawRect(int
the x coordinate of the rectangle to be drawn.
x, int
the y coordinate of the rectangle to be drawn.
y, int
the width of the rectangle to be drawn.
width, int
the height of the rectangle to be drawn.
height)

Overrides java.awt.Graphics.drawRect.

Draws the outline of the specified rectangle.

public void
drawRenderableImage(RenderableImage
the image to be rendered. This method does nothing if img is null.
renderableimage, AffineTransform
the transformation from image space into user space
affinetransform)

Implements abstract java.awt.Graphics2D.drawRenderableImage.

Renders a RenderableImage, applying a transform from image space into user space before drawing.

public void
drawRenderedImage(RenderedImage
the image to be rendered. This method does nothing if img is null.
renderedimage, AffineTransform
the transformation from image space into user space
affinetransform)

Implements abstract java.awt.Graphics2D.drawRenderedImage.

Renders a RenderedImage, applying a transform from image space into user space before drawing.

public void
drawRoundRect(int
the x coordinate of the rectangle to be drawn.
i, int
the y coordinate of the rectangle to be drawn.
j, int
the width of the rectangle to be drawn.
k, int
the height of the rectangle to be drawn.
l, int
the horizontal diameter of the arc at the four corners.
i1, int
the vertical diameter of the arc at the four corners.
j1)

Implements abstract java.awt.Graphics.drawRoundRect.

Draws an outlined round-cornered rectangle using this graphics context's current color.

public void
drawString(String
the String to be rendered
string, float
the x coordinate of the location where the String should be rendered
x, float
the y coordinate of the location where the String should be rendered
y)

Implements abstract java.awt.Graphics2D.drawString.

Renders the text specified by the specified String, using the current text attribute state in the Graphics2D context.

public void
drawString(String
the string to be rendered
string, int
the x coordinate of the location where the String should be rendered
x, int
the y coordinate of the location where the String should be rendered
y)

Implements abstract java.awt.Graphics2D.drawString.

Renders the text of the specified String, using the current text attribute state in the Graphics2D context.

public void
drawString(AttributedCharacterIterator
the iterator whose text is to be rendered
attributedcharacteriterator, float
the x coordinate where the iterator's text is to be rendered
x, float
the y coordinate where the iterator's text is to be rendered
y)

Implements abstract java.awt.Graphics2D.drawString.

Renders the text of the specified iterator applying its attributes in accordance with the specification of the TextAttribute class.

public void
drawString(AttributedCharacterIterator
the iterator whose text is to be rendered
attributedcharacteriterator, int
the x coordinate where the iterator's text is to be rendered
x, int
the y coordinate where the iterator's text is to be rendered
y)

Implements abstract java.awt.Graphics2D.drawString.

Renders the text of the specified iterator applying its attributes in accordance with the specification of the TextAttribute class.

public void
fill(Shape
the Shape to be filled
shape)

Implements abstract java.awt.Graphics2D.fill.

Fills the interior of a Shape using the settings of the Graphics2D context.

public void
fillArc(int
the x coordinate of the upper-left corner of the arc to be filled.
i, int
the y coordinate of the upper-left corner of the arc to be filled.
j, int
the width of the arc to be filled.
k, int
the height of the arc to be filled.
l, int
the beginning angle.
i1, int
the angular extent of the arc, relative to the start angle.
j1)

Implements abstract java.awt.Graphics.fillArc.

Fills a circular or elliptical arc covering the specified rectangle.

public void
fillOval(int
the x coordinate of the upper left corner of the oval to be filled.
x, int
the y coordinate of the upper left corner of the oval to be filled.
y, int
the width of the oval to be filled.
width, int
the height of the oval to be filled.
height)

Implements abstract java.awt.Graphics.fillOval.

Fills an oval bounded by the specified rectangle with the current color.

public void
fillPolygon(int[]
array of the x coordinates.
xPoints, int[]
array of the y coordinates.
yPoints, int
the total number of points in the polygon.
nPoints)

Implements abstract java.awt.Graphics.fillPolygon.

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

public void
fillRect(int
the x coordinate of the rectangle to be filled.
x, int
the y coordinate of the rectangle to be filled.
y, int
the width of the rectangle to be filled.
width, int
the height of the rectangle to be filled.
height)

Implements abstract java.awt.Graphics.fillRect.

Fills the specified rectangle.

public void
fillRoundRect(int
the x coordinate of the rectangle to be filled.
x, int
the y coordinate of the rectangle to be filled.
y, int
the width of the rectangle to be filled.
width, int
the height of the rectangle to be filled.
height, int
the horizontal diameter of the arc at the four corners.
arcWidth, int
the vertical diameter of the arc at the four corners.
arcHeight)

Implements abstract java.awt.Graphics.fillRoundRect.

Fills the specified rounded corner rectangle with the current color.

public Color
getBackground()

Implements abstract java.awt.Graphics2D.getBackground.

Returns the background color used for clearing a region.

public Shape
getClip()

Implements abstract java.awt.Graphics.getClip.

Gets the current clipping area.

public Rectangle
getClipBounds()

Implements abstract java.awt.Graphics.getClipBounds.

Returns the bounding rectangle of the current clipping area.

public Color
getColor()

Implements abstract java.awt.Graphics.getColor.

Gets this graphics context's current color.

public Composite
getComposite()

Implements abstract java.awt.Graphics2D.getComposite.

Returns the current Composite in the Graphics2D context.

private Shape
getDeviceclip()

public GraphicsConfiguration
getDeviceConfiguration()

Implements abstract java.awt.Graphics2D.getDeviceConfiguration.

Returns the device configuration associated with this Graphics2D.

private EscherGraphics
getEscherGraphics()

public Font
getFont()

Implements abstract java.awt.Graphics.getFont.

Gets the current font.

public FontMetrics
getFontMetrics(Font
the specified font
font)

Implements abstract java.awt.Graphics.getFontMetrics.

Gets the font metrics for the specified font.

public FontRenderContext
getFontRenderContext()

Implements abstract java.awt.Graphics2D.getFontRenderContext.

Get the rendering context of the Font within this Graphics2D context.

private Graphics2D
getG2D()

private BufferedImage
getImg()

public Paint
getPaint()

Implements abstract java.awt.Graphics2D.getPaint.

Returns the current Paint of the Graphics2D context.

public Object
getRenderingHint(RenderingHints.Key
the key corresponding to the hint to get.
key)

Implements abstract java.awt.Graphics2D.getRenderingHint.

Returns the value of a single preference for the rendering algorithms.

public RenderingHints
getRenderingHints()

Implements abstract java.awt.Graphics2D.getRenderingHints.

Gets the preferences for the rendering algorithms.

public Stroke
getStroke()

Implements abstract java.awt.Graphics2D.getStroke.

Returns the current Stroke in the Graphics2D context.

private AffineTransform
getTrans()

public AffineTransform
getTransform()

Implements abstract java.awt.Graphics2D.getTransform.

Returns a copy of the current Transform in the Graphics2D context.

public boolean
hit(Rectangle
the area in device space to check for a hit
rectangle, Shape
the Shape to check for a hit
shape, boolean
flag used to choose between testing the stroked or the filled shape. If the flag is true, the Stroke outline is tested. If the flag is false, the filled Shape is tested.
flag)

Implements abstract java.awt.Graphics2D.hit.

Checks whether or not the specified Shape intersects the specified Rectangle, which is in device space.

public void
rotate(double
the angle of rotation in radians
d)

Implements abstract java.awt.Graphics2D.rotate.

Concatenates the current Graphics2D Transform with a rotation transform.

public void
rotate(double
the angle of rotation in radians
d, double
the x coordinate of the origin of the rotation
d1, double
the y coordinate of the origin of the rotation
d2)

Implements abstract java.awt.Graphics2D.rotate.

Concatenates the current Graphics2D Transform with a translated rotation transform.

public void
scale(double
the amount by which X coordinates in subsequent rendering operations are multiplied relative to previous rendering operations.
d, double
the amount by which Y coordinates in subsequent rendering operations are multiplied relative to previous rendering operations.
d1)

Implements abstract java.awt.Graphics2D.scale.

Concatenates the current Graphics2D Transform with a scaling transformation Subsequent rendering is resized according to the specified scaling factors relative to the previous scaling.

public void
setBackground(Color
the background color that is used in subsequent calls to clearRect
c)

Implements abstract java.awt.Graphics2D.setBackground.

Sets the background color for the Graphics2D context.

public void
setClip(int
the x coordinate of the new clip rectangle.
i, int
the y coordinate of the new clip rectangle.
j, int
the width of the new clip rectangle.
k, int
the height of the new clip rectangle.
l)

Implements abstract java.awt.Graphics.setClip.

Sets the current clip to the rectangle specified by the given coordinates.

public void
setClip(Shape
the Shape to use to set the clip. Passing null clears the current clip.
shape)

Implements abstract java.awt.Graphics.setClip.

Sets the current clipping area to an arbitrary clip shape.

public void
setColor(Color
the new rendering color.
c)

Implements abstract java.awt.Graphics.setColor.

Sets this graphics context's current color to the specified color.

public void
setComposite(Composite
the Composite object to be used for rendering
composite)

Implements abstract java.awt.Graphics2D.setComposite.

Sets the Composite for the Graphics2D context.

private void
setDeviceclip(Shape deviceclip)

public void
setFont(Font
the font.
font)

Implements abstract java.awt.Graphics.setFont.

Sets this graphics context's font to the specified font.

private void
setImg(BufferedImage img)

public void
setPaint(Paint
the Paint object to be used to generate color during the rendering process, or null
paint1)

Implements abstract java.awt.Graphics2D.setPaint.

Sets the Paint attribute for the Graphics2D context.

public void
setPaintMode()

Implements abstract java.awt.Graphics.setPaintMode.

Sets the paint mode of this graphics context to overwrite the destination with this graphics context's current color.

public void
setRenderingHint(RenderingHints.Key
the key of the hint to be set.
key, Object
the value indicating preferences for the specified hint category.
obj)

Implements abstract java.awt.Graphics2D.setRenderingHint.

Sets the value of a single preference for the rendering algorithms.

public void
setRenderingHints(Map<?, ?>
the rendering hints to be set
map)

Implements abstract java.awt.Graphics2D.setRenderingHints.

Replaces the values of all preferences for the rendering algorithms with the specified hints.

public void
setStroke(Stroke
the Stroke object to be used to stroke a Shape during the rendering process
s)

Implements abstract java.awt.Graphics2D.setStroke.

Sets the Stroke for the Graphics2D context.

private void
setTrans(AffineTransform trans)

public void
setTransform(AffineTransform
the AffineTransform that was retrieved from the getTransform method
affinetransform)

Implements abstract java.awt.Graphics2D.setTransform.

Overwrites the Transform in the Graphics2D context.

public void
setXORMode(Color
the XOR alternation color
color1)

Implements abstract java.awt.Graphics.setXORMode.

Sets the paint mode of this graphics context to alternate between this graphics context's current color and the new specified color.

public void
shear(double
the multiplier by which coordinates are shifted in the positive X axis direction as a function of their Y coordinate
d, double
the multiplier by which coordinates are shifted in the positive Y axis direction as a function of their X coordinate
d1)

Implements abstract java.awt.Graphics2D.shear.

Concatenates the current Graphics2D Transform with a shearing transform.

public void
transform(AffineTransform
the AffineTransform object to be composed with the current Transform
affinetransform)

Implements abstract java.awt.Graphics2D.transform.

Composes an AffineTransform object with the Transform in this Graphics2D according to the rule last-specified-first-applied.

public void
translate(double
the distance to translate along the x-axis
d, double
the distance to translate along the y-axis
d1)

Implements abstract java.awt.Graphics2D.translate.

Concatenates the current Graphics2D Transform with a translation transform.

public void
translate(int
the specified x coordinate
i, int
the specified y coordinate
j)

Implements abstract java.awt.Graphics2D.translate.

Translates the origin of the Graphics2D context to the point (x, y) in the current coordinate system.

Inherited from java.awt.Graphics2D:
draw3DRectfill3DRect