public class

PeekGraphics

extends Graphics2D
implements ImageObserver PrinterGraphics Cloneable
java.lang.Object
   ↳ java.awt.Graphics
     ↳ java.awt.Graphics2D
       ↳ sun.print.PeekGraphics

Summary

Nested Classes
class PeekGraphics.ImageWaiter This private class does not return from its constructor until 'img's width and height are available. 
[Expand]
Inherited Constants
From interface java.awt.image.ImageObserver
Public Constructors
PeekGraphics(Graphics2D graphics, PrinterJob printerJob)
The new PeekGraphics2D will forward state changing calls to 'graphics'.
Public Methods
void addRenderingHints(Map<?, ?> hints)
Adds a number of preferences for the rendering algorithms.
void clearRect(int x, int y, int width, int height)
Clears the specified rectangle by filling it with the background color of the current drawing surface.
void clip(Shape s)
Intersects the current clip with the interior of the specified Shape and sets the current clip to the resulting intersection.
void clipRect(int x, int y, int width, int height)
Intersects the current clip with the specified rectangle.
void copyArea(int x, int y, int width, int height, int dx, int dy)
Copies an area of the component by a distance specified by dx and dy.
Graphics create()
Creates a new Graphics object that is a copy of this Graphics object.
void dispose()
Disposes of this graphics context and releases any system resources that it is using.
void draw(Shape s)
Strokes the outline of a Shape using the settings of the current graphics state.
void drawArc(int x, int y, int width, int height, int startAngle, int arcAngle)
Draws the outline of a circular or elliptical arc covering the specified rectangle.
void drawGlyphVector(GlyphVector g, float x, float y)
Draws a GlyphVector.
boolean drawImage(Image img, int x, int y, int width, int height, Color bgcolor, ImageObserver observer)
Draws as much of the specified image as has already been scaled to fit inside the specified rectangle.
void drawImage(BufferedImage img, BufferedImageOp op, int x, int y)
Draws a BufferedImage that is filtered with a BufferedImageOp.
boolean drawImage(Image img, int dx1, int dy1, int dx2, int dy2, int sx1, int sy1, int sx2, int sy2, Color bgcolor, ImageObserver observer)
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.
boolean drawImage(Image img, int x, int y, Color bgcolor, ImageObserver observer)
Draws as much of the specified image as is currently available.
boolean drawImage(Image img, int x, int y, ImageObserver observer)
Draws as much of the specified image as is currently available.
boolean drawImage(Image img, AffineTransform xform, ImageObserver obs)
Draws an image, applying a transform from image space into user space before drawing.
boolean drawImage(Image img, int x, int y, int width, int height, ImageObserver observer)
Draws as much of the specified image as has already been scaled to fit inside the specified rectangle.
boolean drawImage(Image img, int dx1, int dy1, int dx2, int dy2, int sx1, int sy1, int sx2, int sy2, ImageObserver observer)
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.
void drawLine(int x1, int y1, int x2, int y2)
Draws a line, using the current color, between the points (x1, y1) and (x2, y2) in this graphics context's coordinate system.
void drawOval(int x, int y, int width, int height)
Draws the outline of an oval.
void drawPolygon(int[] xPoints, int[] yPoints, int nPoints)
Draws a closed polygon defined by arrays of x and y coordinates.
void drawPolyline(int[] xPoints, int[] yPoints, int nPoints)
Draws a sequence of connected lines defined by arrays of x and y coordinates.
void drawRenderableImage(RenderableImage img, AffineTransform xform)
Renders a RenderableImage, applying a transform from image space into user space before drawing.
void drawRenderedImage(RenderedImage img, AffineTransform xform)
Draws an image, applying a transform from image space into user space before drawing.
void drawRoundRect(int x, int y, int width, int height, int arcWidth, int arcHeight)
Draws an outlined round-cornered rectangle using this graphics context's current color.
void drawString(String str, int x, int y)
Draws the text given by the specified string, using this graphics context's current font and color.
void drawString(AttributedCharacterIterator iterator, int x, int y)
Draws the text given by the specified iterator, using this graphics context's current color.
void drawString(AttributedCharacterIterator iterator, float x, float y)
Draws the text given by the specified iterator, using this graphics context's current color.
void drawString(String str, float x, float y)
Draws a string of text.
void fill(Shape s)
Fills the interior of a Shape using the settings of the current graphics state.
void fillArc(int x, int y, int width, int height, int startAngle, int arcAngle)
Fills a circular or elliptical arc covering the specified rectangle.
void fillOval(int x, int y, int width, int height)
Fills an oval bounded by the specified rectangle with the current color.
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)
Fills the specified rectangle.
void fillRoundRect(int x, int y, int width, int height, int arcWidth, int arcHeight)
Fills the specified rounded corner rectangle with the current color.
void finalize()
Empty finalizer as no clean up needed here.
boolean getAWTDrawingOnly()
Color getBackground()
Returns the background color used for clearing a region.
Shape getClip()
Gets the current clipping area.
Rectangle getClipBounds()
Returns the bounding rectangle of the current clipping area.
Color getColor()
Gets this graphics context's current color.
Composite getComposite()
Returns the current Composite in the Graphics2D state.
Graphics2D getDelegate()
Return the Graphics2D object that does the drawing for this instance.
GraphicsConfiguration getDeviceConfiguration()
Returns the device configuration associated with this Graphics2D.
Spans getDrawingArea()
Return a Spans instance describing the parts of the page in to which drawing occurred.
Font getFont()
Gets the current font.
FontMetrics getFontMetrics(Font f)
Gets the font metrics for the specified font.
FontRenderContext getFontRenderContext()
Get the rendering context of the font within this Graphics2D context.
PeekMetrics getMetrics()
Return the object holding the summary of the drawing done by the printing application.
Paint getPaint()
Returns the current Paint in the Graphics2D state.
PrinterJob getPrinterJob()
Returns the PrinterJob that is controlling the current rendering request.
Object getRenderingHint(RenderingHints.Key hintCategory)
Returns the preferences for the rendering algorithms.
RenderingHints getRenderingHints()
Gets the preferences for the rendering algorithms.
Stroke getStroke()
Returns the current Stroke in the Graphics2D state.
AffineTransform getTransform()
Returns the current Transform in the Graphics2D state.
boolean hit(Rectangle rect, Shape s, boolean onStroke)
Checks to see if the outline of a Shape intersects the specified Rectangle in device space.
boolean hitsDrawingArea(Rectangle rect)
Return true if the Rectangle rect intersects the area into which the application has drawn.
synchronized boolean imageUpdate(Image img, int infoFlags, int x, int y, int width, int height)
Notify this object when the height or width become available for an image.
void rotate(double theta, double x, double y)
Concatenates the current transform of this Graphics2D with a translated rotation transformation.
void rotate(double theta)
Concatenates the current transform of this Graphics2D with a rotation transformation.
void scale(double sx, double sy)
Concatenates the current transform of this Graphics2D with a scaling transformation.
void setAWTDrawingOnly()
The caller promises that only AWT graphics will be drawn.
void setBackground(Color color)
Sets the background color in this context used for clearing a region.
void setClip(Shape clip)
Sets the current clipping area to an arbitrary clip shape.
void setClip(int x, int y, int width, int height)
Sets the current clip to the rectangle specified by the given coordinates.
void setColor(Color c)
Sets this graphics context's current color to the specified color.
void setComposite(Composite comp)
Sets the Composite in the current graphics state.
void setDelegate(Graphics2D graphics)
Set the Graphics2D instance which will do the drawing.
void setFont(Font font)
Sets this graphics context's font to the specified font.
void setPaint(Paint paint)
Sets the Paint in the current graphics state.
void setPaintMode()
Sets the paint mode of this graphics context to overwrite the destination with this graphics context's current color.
void setRenderingHint(RenderingHints.Key hintCategory, Object hintValue)
Sets the preferences for the rendering algorithms.
void setRenderingHints(Map<?, ?> hints)
Sets the preferences for the rendering algorithms.
void setStroke(Stroke s)
Sets the Stroke in the current graphics state.
void setTransform(AffineTransform Tx)
Sets the Transform in the current graphics state.
void setXORMode(Color c1)
Sets the paint mode of this graphics context to alternate between this graphics context's current color and the new specified color.
void shear(double shx, double shy)
Concatenates the current transform of this Graphics2D with a shearing transformation.
void transform(AffineTransform Tx)
Composes a Transform object with the transform in this Graphics2D according to the rule last-specified-first-applied.
void translate(int x, int y)
Translates the origin of the graphics context to the point (xy) in the current coordinate system.
void translate(double tx, double ty)
Concatenates the current transform of this Graphics2D with a translation transformation.
[Expand]
Inherited Methods
From class java.awt.Graphics2D
From class java.awt.Graphics
From class java.lang.Object
From interface java.awt.image.ImageObserver
From interface java.awt.print.PrinterGraphics

Public Constructors

public PeekGraphics (Graphics2D graphics, PrinterJob printerJob)

The new PeekGraphics2D will forward state changing calls to 'graphics'. 'printerJob' is stored away so that the printing application can get the PrinterJob if needed.

Public Methods

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

Adds a number of preferences for the rendering algorithms. Hint categories include controls for rendering quality and overall time/quality trade-off in the rendering process.

Parameters
hints The rendering hints to be set
See Also

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

Clears the specified rectangle by filling it with the background color of the current drawing surface. This operation does not use the current paint mode.

Beginning with Java 1.1, the background color of offscreen images may be system dependent. Applications should use setColor followed by fillRect to ensure that an offscreen image is cleared to a specific color.

Parameters
x the x coordinate of the rectangle to clear.
y the y coordinate of the rectangle to clear.
width the width of the rectangle to clear.
height the height of the rectangle to clear.

public void clip (Shape s)

Intersects the current clip with the interior of the specified Shape and sets the current clip to the resulting intersection. The indicated shape is transformed with the current transform in the Graphics2D state before being intersected with the current clip. This method is used to make the current clip smaller. To make the clip larger, use any setClip method.

Parameters
s The Shape to be intersected with the current clip.

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

Intersects the current clip with the specified rectangle. The resulting clipping area is the intersection of the current clipping area and the specified rectangle. This method can only be used to make the current clip smaller. To set the current clip larger, use any of the setClip methods. Rendering operations have no effect outside of the clipping area.

Parameters
x the x coordinate of the rectangle to intersect the clip with
y the y coordinate of the rectangle to intersect the clip with
width the width of the rectangle to intersect the clip with
height the height of the rectangle to intersect the clip with

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

Copies an area of the component by a distance specified by dx and dy. From the point specified by x and y, this method copies downwards and to the right. To copy an area of the component to the left or upwards, specify a negative value for dx or dy. If a portion of the source rectangle lies outside the bounds of the component, or is obscured by another window or component, copyArea will be unable to copy the associated pixels. The area that is omitted can be refreshed by calling the component's paint method.

Parameters
x the x coordinate of the source rectangle.
y the y coordinate of the source rectangle.
width the width of the source rectangle.
height the height of the source rectangle.
dx the horizontal distance to copy the pixels.
dy the vertical distance to copy the pixels.

public Graphics create ()

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

Returns
  • a new graphics context that is a copy of this graphics context.

public void dispose ()

Disposes of this graphics context and releases any system resources that it is using. A Graphics object cannot be used after disposehas been called.

When a Java program runs, a large number of Graphics objects can be created within a short time frame. Although the finalization process of the garbage collector also disposes of the same system resources, it is preferable to manually free the associated resources by calling this method rather than to rely on a finalization process which may not run to completion for a long period of time.

Graphics objects which are provided as arguments to the paint and update methods of components are automatically released by the system when those methods return. For efficiency, programmers should call dispose when finished using a Graphics object only if it was created directly from a component or another Graphics object.

public void draw (Shape s)

Strokes the outline of a Shape using the settings of the current graphics state. The rendering attributes applied include the clip, transform, paint or color, composite and stroke attributes.

Parameters
s The shape to be drawn.

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

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

The resulting arc begins at startAngle and extends for arcAngle degrees, using the current color. Angles are interpreted such that 0 degrees is at the 3 o'clock position. A positive value indicates a counter-clockwise rotation while a negative value indicates a clockwise rotation.

The center of the arc is the center of the rectangle whose origin is (xy) and whose size is specified by the width and height arguments.

The resulting arc covers an area width + 1 pixels wide by height + 1 pixels tall.

Parameters
x the x coordinate of the upper-left corner of the arc to be drawn.
y the y coordinate of the upper-left corner of the arc to be drawn.
width the width of the arc to be drawn.
height the height of the arc to be drawn.
startAngle the beginning angle.
arcAngle the angular extent of the arc, relative to the start angle.

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

Draws a GlyphVector. The rendering attributes applied include the clip, transform, paint or color, and composite attributes. The GlyphVector specifies individual glyphs from a Font.

Parameters
g The GlyphVector to be drawn.
x the x position in User Space where the glyphs should be rendered
y the y position in User Space where the glyphs should be rendered

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

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

The image is drawn inside the specified rectangle of this graphics context's coordinate space, and is scaled if necessary. Transparent pixels are drawn in the specified background color. This operation is equivalent to filling a rectangle of the width and height of the specified image with the given color and then drawing the image on top of it, but possibly more efficient.

This method returns immediately in all cases, even if the entire image has not yet been scaled, dithered, and converted for the current output device. If the current output representation is not yet complete then drawImage returns false. As more of the image becomes available, the process that draws the image notifies the specified image observer.

A scaled version of an image will not necessarily be available immediately just because an unscaled version of the image has been constructed for this output device. Each size of the image may be cached separately and generated from the original data in a separate image production sequence.

Parameters
img the specified image to be drawn.
x the x coordinate.
y the y coordinate.
width the width of the rectangle.
height the height of the rectangle.
bgcolor the background color to paint under the non-opaque portions of the image.
observer object to be notified as more of the image is converted.
Returns
  • false if the image pixels are still changing; true otherwise.

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

Draws a BufferedImage that is filtered with a BufferedImageOp. The rendering attributes applied include the clip, transform and composite attributes. This is equivalent to:

 img1 = op.filter(img, null);
 drawImage(img1, new AffineTransform(1f,0f,0f,1f,x,y), null);
 

Parameters
img The BufferedImage to be drawn.
op The filter to be applied to the image before drawing.
x the x coordinate of the location in user space where the upper left corner of the image is rendered
y the y coordinate of the location in user space where the upper left corner of the image is rendered

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)

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.

Transparent pixels are drawn in the specified background color. This operation is equivalent to filling a rectangle of the width and height of the specified image with the given color and then drawing the image on top of it, but possibly more efficient.

This method returns immediately in all cases, even if the image area to be drawn has not yet been scaled, dithered, and converted for the current output device. If the current output representation is not yet complete then drawImage returns false. As more of the image becomes available, the process that draws the image notifies the specified image observer.

This method always uses the unscaled version of the image to render the scaled rectangle and performs the required scaling on the fly. It does not use a cached, scaled version of the image for this operation. Scaling of the image from source to destination is performed such that the first coordinate of the source rectangle is mapped to the first coordinate of the destination rectangle, and the second source coordinate is mapped to the second destination coordinate. The subimage is scaled and flipped as needed to preserve those mappings.

Parameters
img the specified image to be drawn
dx1 the x coordinate of the first corner of the destination rectangle.
dy1 the y coordinate of the first corner of the destination rectangle.
dx2 the x coordinate of the second corner of the destination rectangle.
dy2 the y coordinate of the second corner of the destination rectangle.
sx1 the x coordinate of the first corner of the source rectangle.
sy1 the y coordinate of the first corner of the source rectangle.
sx2 the x coordinate of the second corner of the source rectangle.
sy2 the y coordinate of the second corner of the source rectangle.
bgcolor the background color to paint under the non-opaque portions of the image.
observer object to be notified as more of the image is scaled and converted.
Returns
  • false if the image pixels are still changing; true otherwise.

public boolean drawImage (Image img, int x, int y, Color bgcolor, ImageObserver observer)

Draws as much of the specified image as is currently available. The image is drawn with its top-left corner at (xy) in this graphics context's coordinate space. Transparent pixels are drawn in the specified background color.

This operation is equivalent to filling a rectangle of the width and height of the specified image with the given color and then drawing the image on top of it, but possibly more efficient.

This method returns immediately in all cases, even if the complete image has not yet been loaded, and it has not been dithered and converted for the current output device.

If the image has not yet been completely loaded, then drawImage returns false. As more of the image becomes available, the process that draws the image notifies the specified image observer.

Parameters
img the specified image to be drawn.
x the x coordinate.
y the y coordinate.
bgcolor the background color to paint under the non-opaque portions of the image.
observer object to be notified as more of the image is converted.
Returns
  • false if the image pixels are still changing; true otherwise.

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

Draws as much of the specified image as is currently available. The image is drawn with its top-left corner at (xy) in this graphics context's coordinate space. Transparent pixels in the image do not affect whatever pixels are already there.

This method returns immediately in all cases, even if the complete image has not yet been loaded, and it has not been dithered and converted for the current output device.

If the image has not yet been completely loaded, then drawImage returns false. As more of the image becomes available, the process that draws the image notifies the specified image observer.

Parameters
img the specified image to be drawn.
x the x coordinate.
y the y coordinate.
observer object to be notified as more of the image is converted.
Returns
  • false if the image pixels are still changing; true otherwise.

public boolean drawImage (Image img, AffineTransform xform, ImageObserver obs)

Draws an image, applying a transform from image space into user space before drawing. The transformation from user space into device space is done with the current transform in the Graphics2D. The given transformation is applied to the image before the transform attribute in the Graphics2D state is applied. The rendering attributes applied include the clip, transform, and composite attributes. Note that the result is undefined, if the given transform is noninvertible.

Parameters
img The image to be drawn.
xform The transformation from image space into user space.
obs The image observer to be notified as more of the image is converted.
Returns
  • true if the Image is fully loaded and completely rendered, or if it's null; false if the Image is still being loaded.

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

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

The image is drawn inside the specified rectangle of this graphics context's coordinate space, and is scaled if necessary. Transparent pixels do not affect whatever pixels are already there.

This method returns immediately in all cases, even if the entire image has not yet been scaled, dithered, and converted for the current output device. If the current output representation is not yet complete, then drawImage returns false. As more of the image becomes available, the process that draws the image notifies the image observer by calling its imageUpdate method.

A scaled version of an image will not necessarily be available immediately just because an unscaled version of the image has been constructed for this output device. Each size of the image may be cached separately and generated from the original data in a separate image production sequence.

Parameters
img the specified image to be drawn.
x the x coordinate.
y the y coordinate.
width the width of the rectangle.
height the height of the rectangle.
observer object to be notified as more of the image is converted.
Returns
  • false if the image pixels are still changing; true otherwise.

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

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. Transparent pixels do not affect whatever pixels are already there.

This method returns immediately in all cases, even if the image area to be drawn has not yet been scaled, dithered, and converted for the current output device. If the current output representation is not yet complete then drawImage returns false. As more of the image becomes available, the process that draws the image notifies the specified image observer.

This method always uses the unscaled version of the image to render the scaled rectangle and performs the required scaling on the fly. It does not use a cached, scaled version of the image for this operation. Scaling of the image from source to destination is performed such that the first coordinate of the source rectangle is mapped to the first coordinate of the destination rectangle, and the second source coordinate is mapped to the second destination coordinate. The subimage is scaled and flipped as needed to preserve those mappings.

Parameters
img the specified image to be drawn
dx1 the x coordinate of the first corner of the destination rectangle.
dy1 the y coordinate of the first corner of the destination rectangle.
dx2 the x coordinate of the second corner of the destination rectangle.
dy2 the y coordinate of the second corner of the destination rectangle.
sx1 the x coordinate of the first corner of the source rectangle.
sy1 the y coordinate of the first corner of the source rectangle.
sx2 the x coordinate of the second corner of the source rectangle.
sy2 the y coordinate of the second corner of the source rectangle.
observer object to be notified as more of the image is scaled and converted.
Returns
  • false if the image pixels are still changing; true otherwise.

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

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

Parameters
x1 the first point's x coordinate.
y1 the first point's y coordinate.
x2 the second point's x coordinate.
y2 the second point's y coordinate.

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

Draws the outline of an oval. The result is a circle or ellipse that fits within the rectangle specified by the x, y, width, and height arguments.

The oval covers an area that is width + 1 pixels wide and height + 1 pixels tall.

Parameters
x the x coordinate of the upper left corner of the oval to be drawn.
y the y coordinate of the upper left corner of the oval to be drawn.
width the width of the oval to be drawn.
height the height of the oval to be drawn.

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

Draws a closed polygon defined by arrays of x and y coordinates. Each pair of (xy) coordinates defines a point.

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.

Parameters
xPoints a an array of x coordinates.
yPoints a an array of y coordinates.
nPoints a the total number of points.

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

Draws a sequence of connected lines defined by arrays of x and y coordinates. Each pair of (xy) coordinates defines a point. The figure is not closed if the first point differs from the last point.

Parameters
xPoints an array of x points
yPoints an array of y points
nPoints the total number of points

public void drawRenderableImage (RenderableImage img, AffineTransform xform)

Renders a RenderableImage, applying a transform from image space into user space before drawing. The transformation from user space into device space is done with the current Transform in the Graphics2D. The specified transformation is applied to the image before the transform attribute in the Graphics2D context is applied. The rendering attributes applied include the Clip, Transform, and Composite attributes. Note that no rendering is done if the specified transform is noninvertible.

Rendering hints set on the Graphics2D object might be used in rendering the RenderableImage. If explicit control is required over specific hints recognized by a specific RenderableImage, or if knowledge of which hints are used is required, then a RenderedImage should be obtained directly from the RenderableImage and rendered using drawRenderedImage.

Parameters
img the image to be rendered. This method does nothing if img is null.
xform the transformation from image space into user space

public void drawRenderedImage (RenderedImage img, AffineTransform xform)

Draws an image, applying a transform from image space into user space before drawing. The transformation from user space into device space is done with the current transform in the Graphics2D. The given transformation is applied to the image before the transform attribute in the Graphics2D state is applied. The rendering attributes applied include the clip, transform, and composite attributes. Note that the result is undefined, if the given transform is noninvertible.

Parameters
img The image to be drawn.
xform The transformation from image space into user space.

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

Draws an outlined round-cornered rectangle using this graphics context's current color. The left and right edges of the rectangle are at x and x + width, respectively. The top and bottom edges of the rectangle are at y and y + height.

Parameters
x the x coordinate of the rectangle to be drawn.
y the y coordinate of the rectangle to be drawn.
width the width of the rectangle to be drawn.
height the height of the rectangle to be drawn.
arcWidth the horizontal diameter of the arc at the four corners.
arcHeight the vertical diameter of the arc at the four corners.

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

Draws the text given by the specified string, using this graphics context's current font and color. The baseline of the first character is at position (xy) in this graphics context's coordinate system.

Parameters
str the string to be drawn.
x the x coordinate.
y the y coordinate.

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

Draws the text given by the specified iterator, using this graphics context's current color. The iterator has to specify a font for each character. The baseline of the first character is at position (xy) in this graphics context's coordinate system. The rendering attributes applied include the clip, transform, paint or color, and composite attributes. For characters in script systems such as Hebrew and Arabic, the glyphs may be draw from right to left, in which case the coordinate supplied is the the location of the leftmost character on the baseline.

Parameters
iterator the iterator whose text is to be drawn
x the x coordinate where the iterator's text is to be rendered
y the y coordinate where the iterator's text is to be rendered

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

Draws the text given by the specified iterator, using this graphics context's current color. The iterator has to specify a font for each character. The baseline of the first character is at position (xy) in this graphics context's coordinate system. The rendering attributes applied include the clip, transform, paint or color, and composite attributes. For characters in script systems such as Hebrew and Arabic, the glyphs may be draw from right to left, in which case the coordinate supplied is the the location of the leftmost character on the baseline.

Parameters
iterator the iterator whose text is to be drawn
x the x coordinate where the iterator's text is to be rendered
y the y coordinate where the iterator's text is to be rendered

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

Draws a string of text. The rendering attributes applied include the clip, transform, paint or color, font and composite attributes.

Parameters
str the String to be rendered
x the x coordinate of the location where the String should be rendered
y the y coordinate of the location where the String should be rendered

public void fill (Shape s)

Fills the interior of a Shape using the settings of the current graphics state. The rendering attributes applied include the clip, transform, paint or color, and composite.

Parameters
s the Shape to be filled

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

Fills a circular or elliptical arc covering the specified rectangle.

The resulting arc begins at startAngle and extends for arcAngle degrees. Angles are interpreted such that 0 degrees is at the 3 o'clock position. A positive value indicates a counter-clockwise rotation while a negative value indicates a clockwise rotation.

The center of the arc is the center of the rectangle whose origin is (xy) and whose size is specified by the width and height arguments.

The resulting arc covers an area width + 1 pixels wide by height + 1 pixels tall.

Parameters
x the x coordinate of the upper-left corner of the arc to be filled.
y the y coordinate of the upper-left corner of the arc to be filled.
width the width of the arc to be filled.
height the height of the arc to be filled.
startAngle the beginning angle.
arcAngle the angular extent of the arc, relative to the start angle.

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

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

Parameters
x the x coordinate of the upper left corner of the oval to be filled.
y the y coordinate of the upper left corner of the oval to be filled.
width the width of the oval to be filled.
height the height of the oval to be filled.

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.

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

Fills the specified rectangle. The left and right edges of the rectangle are at x and x + width - 1. The top and bottom edges are at y and y + height - 1. The resulting rectangle covers an area width pixels wide by height pixels tall. The rectangle is filled using the graphics context's current color.

Parameters
x the x coordinate of the rectangle to be filled.
y the y coordinate of the rectangle to be filled.
width the width of the rectangle to be filled.
height the height of the rectangle to be filled.

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

Fills the specified rounded corner rectangle with the current color. The left and right edges of the rectangle are at x and x + width - 1, respectively. The top and bottom edges of the rectangle are at y and y + height - 1.

Parameters
x the x coordinate of the rectangle to be filled.
y the y coordinate of the rectangle to be filled.
width the width of the rectangle to be filled.
height the height of the rectangle to be filled.
arcWidth the horizontal diameter of the arc at the four corners.
arcHeight the vertical diameter of the arc at the four corners.

public void finalize ()

Empty finalizer as no clean up needed here.

public boolean getAWTDrawingOnly ()

public Color getBackground ()

Returns the background color used for clearing a region.

Returns
  • the current Graphics2D Color, which defines the background color.
See Also
  • setBackground

public Shape getClip ()

Gets the current clipping area.

Returns
  • a Shape object representing the current clipping area.

public Rectangle getClipBounds ()

Returns the bounding rectangle of the current clipping area. The coordinates in the rectangle are relative to the coordinate system origin of this graphics context.

Returns
  • the bounding rectangle of the current clipping area.

public Color getColor ()

Gets this graphics context's current color.

Returns
  • this graphics context's current color.

public Composite getComposite ()

Returns the current Composite in the Graphics2D state.

Returns
  • the current Graphics2D Composite, which defines a compositing style.

public Graphics2D getDelegate ()

Return the Graphics2D object that does the drawing for this instance.

public GraphicsConfiguration getDeviceConfiguration ()

Returns the device configuration associated with this Graphics2D.

Returns
  • the device configuration of this Graphics2D.

public Spans getDrawingArea ()

Return a Spans instance describing the parts of the page in to which drawing occurred.

public Font getFont ()

Gets the current font.

Returns
  • this graphics context's current font.

public FontMetrics getFontMetrics (Font f)

Gets the font metrics for the specified font.

Parameters
f the specified font
Returns
  • the font metrics for the specified font.

public FontRenderContext getFontRenderContext ()

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

Returns
  • a reference to an instance of FontRenderContext.

public PeekMetrics getMetrics ()

Return the object holding the summary of the drawing done by the printing application.

public Paint getPaint ()

Returns the current Paint in the Graphics2D state.

Returns
  • the current Graphics2D Paint, which defines a color or pattern.

public PrinterJob getPrinterJob ()

Returns the PrinterJob that is controlling the current rendering request.

Returns
  • the PrinterJob controlling the current rendering request.

public Object getRenderingHint (RenderingHints.Key hintCategory)

Returns the preferences for the rendering algorithms.

Parameters
hintCategory The category of hint to be set.
Returns
  • The preferences for rendering algorithms.
See Also
  • RenderingHings

public RenderingHints getRenderingHints ()

Gets the preferences for the rendering algorithms. Hint categories include controls for rendering quality and overall time/quality trade-off in the rendering process.

Returns
  • a reference to an instance of RenderingHints that contains the current preferences.
See Also

public Stroke getStroke ()

Returns the current Stroke in the Graphics2D state.

Returns
  • the current Graphics2D Stroke, which defines the line style.
See Also
  • setStroke

public AffineTransform getTransform ()

Returns the current Transform in the Graphics2D state.

Returns
  • the current AffineTransform in the Graphics2D context.

public boolean hit (Rectangle rect, Shape s, boolean onStroke)

Checks to see if the outline of a Shape intersects the specified Rectangle in device space. The rendering attributes taken into account include the clip, transform, and stroke attributes.

Parameters
rect The area in device space to check for a hit.
s The shape to check for a hit.
onStroke Flag to choose between testing the stroked or the filled shape.
Returns
  • True if there is a hit, false otherwise.

public boolean hitsDrawingArea (Rectangle rect)

Return true if the Rectangle rect intersects the area into which the application has drawn.

public synchronized boolean imageUpdate (Image img, int infoFlags, int x, int y, int width, int height)

Notify this object when the height or width become available for an image.

Parameters
img the image being observed.
infoFlags the bitwise inclusive OR of the following flags: WIDTH, HEIGHT, PROPERTIES, SOMEBITS, FRAMEBITS, ALLBITS, ERROR, ABORT.
x the x coordinate.
y the y coordinate.
width the width.
height the height.
Returns
  • false if the infoflags indicate that the image is completely loaded; true otherwise.

public void rotate (double theta, double x, double y)

Concatenates the current transform of this Graphics2D with a translated rotation transformation. This is equivalent to the following sequence of calls:

          translate(x, y);
          rotate(theta);
          translate(-x, -y);
 
Rotating with a positive angle theta rotates points on the positive x axis toward the positive y axis.

Parameters
theta The angle of rotation in radians.
x The x coordinate of the origin of the rotation
y The x coordinate of the origin of the rotation

public void rotate (double theta)

Concatenates the current transform of this Graphics2D with a rotation transformation. This is equivalent to calling transform(R), where R is an AffineTransform represented by the following matrix:

          [   cos(theta)    -sin(theta)    0   ]
          [   sin(theta)     cos(theta)    0   ]
          [       0              0         1   ]
 
Rotating with a positive angle theta rotates points on the positive x axis toward the positive y axis.

Parameters
theta The angle of rotation in radians.

public void scale (double sx, double sy)

Concatenates the current transform of this Graphics2D with a scaling transformation. This is equivalent to calling transform(S), where S is an AffineTransform represented by the following matrix:

          [   sx   0    0   ]
          [   0    sy   0   ]
          [   0    0    1   ]
 

Parameters
sx the amount by which X coordinates in subsequent rendering operations are multiplied relative to previous rendering operations.
sy the amount by which Y coordinates in subsequent rendering operations are multiplied relative to previous rendering operations.

public void setAWTDrawingOnly ()

The caller promises that only AWT graphics will be drawn. The print system can use this information to make general assumptions about the types of graphics to be drawn without requiring the application to draw the contents multiple times.

public void setBackground (Color color)

Sets the background color in this context used for clearing a region. When Graphics2D is constructed for a component, the backgroung color is inherited from the component. Setting the background color in the Graphics2D context only affects the subsequent clearRect() calls and not the background color of the component. To change the background of the component, use appropriate methods of the component.

Parameters
color The background color that should be used in subsequent calls to clearRect().
See Also
  • getBackground
  • Graphics.clearRect()

public void setClip (Shape clip)

Sets the current clipping area to an arbitrary clip shape. Not all objects which implement the Shape interface can be used to set the clip. The only Shape objects which are guaranteed to be supported are Shape objects which are obtained via the getClip method and via Rectangle objects.

Parameters
clip the Shape to use to set the clip

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

Sets the current clip to the rectangle specified by the given coordinates. Rendering operations have no effect outside of the clipping area.

Parameters
x the x coordinate of the new clip rectangle.
y the y coordinate of the new clip rectangle.
width the width of the new clip rectangle.
height the height of the new clip rectangle.

public void setColor (Color c)

Sets this graphics context's current color to the specified color. All subsequent graphics operations using this graphics context use this specified color.

Parameters
c the new rendering color.
See Also

public void setComposite (Composite comp)

Sets the Composite in the current graphics state. Composite is used in all drawing methods such as drawImage, drawString, draw, and fill. It specifies how new pixels are to be combined with the existing pixels on the graphics device in the rendering process.

Parameters
comp The Composite object to be used for drawing.
See Also

public void setDelegate (Graphics2D graphics)

Set the Graphics2D instance which will do the drawing.

public void setFont (Font font)

Sets this graphics context's font to the specified font. All subsequent text operations using this graphics context use this font.

Parameters
font the font.
See Also
  • getFont()
  • java.awt.Graphics#drawChars(java.lang.String, int, int)
  • java.awt.Graphics#drawString(byte[], int, int, int, int)
  • java.awt.Graphics#drawBytes(char[], int, int, int, int)

public void setPaint (Paint paint)

Sets the Paint in the current graphics state.

Parameters
paint The Paint object to be used to generate color in the rendering process.
See Also

public void setPaintMode ()

Sets the paint mode of this graphics context to overwrite the destination with this graphics context's current color. This sets the logical pixel operation function to the paint or overwrite mode. All subsequent rendering operations will overwrite the destination with the current color.

public void setRenderingHint (RenderingHints.Key hintCategory, Object hintValue)

Sets the preferences for the rendering algorithms. Hint categories include controls for rendering quality and overall time/quality trade-off in the rendering process.

Parameters
hintCategory The category of hint to be set.
hintValue The value indicating preferences for the specified hint category.
See Also

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

Sets the preferences for the rendering algorithms. Hint categories include controls for rendering quality and overall time/quality trade-off in the rendering process.

Parameters
hints The rendering hints to be set
See Also

public void setStroke (Stroke s)

Sets the Stroke in the current graphics state.

Parameters
s The Stroke object to be used to stroke a Shape in the rendering process.
See Also

public void setTransform (AffineTransform Tx)

Sets the Transform in the current graphics state.

Parameters
Tx The Transform object to be used in the rendering process.

public void setXORMode (Color c1)

Sets the paint mode of this graphics context to alternate between this graphics context's current color and the new specified color. This specifies that logical pixel operations are performed in the XOR mode, which alternates pixels between the current color and a specified XOR color.

When drawing operations are performed, pixels which are the current color are changed to the specified color, and vice versa.

Pixels that are of colors other than those two colors are changed in an unpredictable but reversible manner; if the same figure is drawn twice, then all pixels are restored to their original values.

Parameters
c1 the XOR alternation color

public void shear (double shx, double shy)

Concatenates the current transform of this Graphics2D with a shearing transformation. This is equivalent to calling transform(SH), where SH is an AffineTransform represented by the following matrix:

          [   1   shx   0   ]
          [  shy   1    0   ]
          [   0    0    1   ]
 

Parameters
shx The factor by which coordinates are shifted towards the positive X axis direction according to their Y coordinate
shy The factor by which coordinates are shifted towards the positive Y axis direction according to their X coordinate

public void transform (AffineTransform Tx)

Composes a Transform object with the transform in this Graphics2D according to the rule last-specified-first-applied. If the currrent transform is Cx, the result of composition with Tx is a new transform Cx'. Cx' becomes the current transform for this Graphics2D. Transforming a point p by the updated transform Cx' is equivalent to first transforming p by Tx and then transforming the result by the original transform Cx. In other words, Cx'(p) = Cx(Tx(p)). A copy of the Tx is made, if necessary, so further modifications to Tx do not affect rendering.

Parameters
Tx The Transform object to be composed with the current transform.

public void translate (int x, int y)

Translates the origin of the graphics context to the point (xy) in the current coordinate system. Modifies this graphics context so that its new origin corresponds to the point (xy) in this graphics context's original coordinate system. All coordinates used in subsequent rendering operations on this graphics context will be relative to this new origin.

Parameters
x the x coordinate.
y the y coordinate.

public void translate (double tx, double ty)

Concatenates the current transform of this Graphics2D with a translation transformation. This is equivalent to calling transform(T), where T is an AffineTransform represented by the following matrix:

          [   1    0    tx  ]
          [   0    1    ty  ]
          [   0    0    1   ]
 

Parameters
tx the distance to translate along the x-axis
ty the distance to translate along the y-axis