org.pentaho.reporting.tools.configeditor.util

Class BugFixProxyGraphics2D

java.lang.Object

java.awt.Graphics

java.awt.Graphics2D

org.pentaho.reporting.tools.configeditor.util.BugFixProxyGraphics2D

public class BugFixProxyGraphics2D
extends Graphics2D

This documents another sad chapter in Sun's java implementation. The tree cell renderer does not check the clipping of the painted graphics correctly.

This bug seems to be related to the TreeCellRenderer's unability to display the defined (and drawn) background of the CellRenderers render component.

A first hint of that bug can be found at http://www.cs.cf.ac.uk/Dave/HCI/HCI_Handout_CALLER/node155.html

Author:

Thomas Morgner

Constructor Summary

Constructors

Constructor and Description
BugFixProxyGraphics2D(Graphics2D parent) Creates a new proxy to fix some of the Swing bugs.

Method Summary

Modifier and Type	Method and Description
void	addRenderingHints(Map hints) Forwards the call to the parent.
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 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) Forwards the call to the parent.
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) Forwards the call to the parent.
void	drawImage(BufferedImage img, BufferedImageOp op, int x, int y) Renders a BufferedImage that is filtered with a BufferedImageOp.
boolean	drawImage(Image img, AffineTransform xform, ImageObserver obs) Forwards the call to the parent.
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, 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.
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, 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 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	drawPolygon(Polygon p) Draws the outline of a polygon defined by the specified Polygon object.
void	drawPolyline(int[] xPoints, int[] yPoints, int nPoints) Draws a sequence of connected lines defined by arrays of x and y coordinates.
void	drawRect(int x, int y, int width, int height) Draws the outline of the specified rectangle.
void	drawRenderableImage(RenderableImage img, AffineTransform xform) Forwards the call to the parent.
void	drawRenderedImage(RenderedImage img, AffineTransform xform) Forwards the call to the parent.
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(AttributedCharacterIterator iterator, float x, float y) Forwards the call to the parent.
void	drawString(AttributedCharacterIterator iterator, int x, int y) Forwards the call to the parent.
void	drawString(String s, float x, float y) Forwards the call to the parent.
void	drawString(String str, int x, int y) Forwards the call to the parent.
void	fill(Shape s) Forwards the call to the parent.
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	fillPolygon(Polygon p) Fills the polygon defined by the specified Polygon object with the graphics context's current color.
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.
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 context.
GraphicsConfiguration	getDeviceConfiguration() Returns the device configuration associated with this Graphics2D.
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.
Paint	getPaint() Returns the current Paint of the Graphics2D context.
Object	getRenderingHint(RenderingHints.Key hintKey) Forwards the call to the parent.
RenderingHints	getRenderingHints() Forwards the call to the parent.
Stroke	getStroke() Returns the current Stroke in the Graphics2D context.
AffineTransform	getTransform() Returns a copy of the current Transform in the Graphics2D context.
boolean	hit(Rectangle rect, Shape s, boolean onStroke) Forwards the call to the parent.
void	rotate(double theta) Concatenates the current Graphics2D Transform with a rotation transform.
void	rotate(double theta, double x, double y) Concatenates the current Graphics2D Transform with a translated rotation transform.
void	scale(double sx, double sy) Concatenates the current Graphics2D Transform with a scaling transformation Subsequent rendering is resized according to the specified scaling factors relative to the previous scaling.
void	setBackground(Color color) Sets the background color for the Graphics2D context.
void	setClip(int x, int y, int width, int height) Sets the current clip to the rectangle specified by the given coordinates.
void	setClip(Shape clip) Sets the current clipping area to an arbitrary clip shape.
void	setColor(Color c) Sets this graphics context's current color to the specified color.
void	setComposite(Composite comp) Forwards the call to the parent.
void	setFont(Font font) Sets this graphics context's font to the specified font.
void	setPaint(Paint paint) Forwards the call to the parent.
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 hintKey, Object hintValue) Forwards the call to the parent.
void	setRenderingHints(Map hints) Forwards the call to the parent.
void	setStroke(Stroke s) Sets the Stroke for the Graphics2D context.
void	setTransform(AffineTransform tx) Overwrites the Transform in the Graphics2D context.
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 Graphics2D Transform with a shearing transform.
void	transform(AffineTransform tx) Composes an AffineTransform object with the Transform in this Graphics2D according to the rule last-specified-first-applied.
void	translate(double tx, double ty) Concatenates the current Graphics2D Transform with a translation transform.
void	translate(int x, int y) Forwards the call to the parent.

Methods inherited from class java.awt.Graphics2D

draw3DRect, fill3DRect

Methods inherited from class java.awt.Graphics

create, drawBytes, drawChars, finalize, getClipBounds, getClipRect, getFontMetrics, hitClip, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BugFixProxyGraphics2D

public BugFixProxyGraphics2D(Graphics2D parent)

Creates a new proxy to fix some of the Swing bugs.

Parameters:

parent - the original graphics object

Method Detail

draw

public void draw(Shape s)

Forwards the call to the parent.

Specified by:

draw in class Graphics2D

Parameters:

s - the Shape to be rendered

drawImage

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

Forwards the call to the parent.

Specified by:

drawImage in class Graphics2D

Parameters:

img - the Image to be rendered

xform - the transformation from image space into user space

obs - the ImageObserver to be notified as more of the Image is converted

Returns:

true if the Image is fully loaded and completely rendered; false if the Image is still being loaded.

drawImage

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

Renders 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);
 

Specified by:

drawImage in class Graphics2D

Parameters:

op - the filter to be applied to the image before rendering

img - the BufferedImage to be rendered

x - the painting location ...

y - the location in user space where the upper left corner of the image is rendered

See Also:

transform(java.awt.geom.AffineTransform), setTransform(java.awt.geom.AffineTransform), setComposite(java.awt.Composite), clip(java.awt.Shape), setClip(int, int, int, int)

drawRenderedImage

public void drawRenderedImage(RenderedImage img,
                              AffineTransform xform)

Forwards the call to the parent.

Specified by:

drawRenderedImage in class Graphics2D

Parameters:

img - the image to be rendered

xform - the transformation from image space into user space

drawRenderableImage

public void drawRenderableImage(RenderableImage img,
                                AffineTransform xform)

Forwards the call to the parent.

Specified by:

drawRenderableImage in class Graphics2D

Parameters:

img - the image to be rendered

xform - the transformation from image space into user space

drawString

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

Forwards the call to the parent.

Specified by:

drawString in class Graphics2D

Parameters:

str - the string to be rendered

x - coordinates

y - the coordinates where the String should be rendered

Throws:

NullPointerException - if str is null

Since:

JDK1.0

drawString

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

Forwards the call to the parent.

Specified by:

drawString in class Graphics2D

Parameters:

s - the String to be rendered

x - coordinates.

y - the coordinates where the String should be rendered

Throws:

NullPointerException - if str is null

drawString

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

Forwards the call to the parent.

Specified by:

drawString in class Graphics2D

Parameters:

iterator - the iterator whose text is to be rendered

x - coords.

y - the coordinates where the iterator's text is to be rendered

drawString

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

Forwards the call to the parent.

Specified by:

drawString in class Graphics2D

Parameters:

iterator - the iterator whose text is to be rendered

x - coords

y - the coordinates where the iterator's text is to be rendered

drawGlyphVector

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

Forwards the call to the parent.

Specified by:

drawGlyphVector in class Graphics2D

Parameters:

g - the GlyphVector to be rendered

x - coordinates.

y - the position in User Space where the glyphs should be rendered

fill

public void fill(Shape s)

Forwards the call to the parent.

Specified by:

fill in class Graphics2D

Parameters:

s - the Shape to be filled

hit

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

Forwards the call to the parent.

Specified by:

hit in class Graphics2D

Parameters:

rect - the area in device space to check for a hit

s - the Shape to check for a hit

onStroke - flag used to choose between testing the stroked or the filled shape. If the flag is true, the Stroke oultine is tested. If the flag is false, the filled Shape is tested.

Returns:

true if there is a hit; false otherwise.

getDeviceConfiguration

public GraphicsConfiguration getDeviceConfiguration()

Returns the device configuration associated with this Graphics2D.

Specified by:

getDeviceConfiguration in class Graphics2D

Returns:

the device configuration of this Graphics2D.

setComposite

public void setComposite(Composite comp)

Forwards the call to the parent.

Specified by:

setComposite in class Graphics2D

Parameters:

comp - the Composite object to be used for rendering

Throws:

SecurityException - if a custom Composite object is being used to render to the screen and a security manager is set and its checkPermission method does not allow the operation.

setPaint

public void setPaint(Paint paint)

Forwards the call to the parent.

Specified by:

setPaint in class Graphics2D

Parameters:

paint - the Paint object to be used to generate color during the rendering process, or null

setStroke

public void setStroke(Stroke s)

Sets the Stroke for the Graphics2D context.

Specified by:

setStroke in class Graphics2D

Parameters:

s - the Stroke object to be used to stroke a Shape during the rendering process

setRenderingHint

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

Forwards the call to the parent.

Specified by:

setRenderingHint in class Graphics2D

Parameters:

hintKey - the key of the hint to be set.

hintValue - the value indicating preferences for the specified hint category.

getRenderingHint

public Object getRenderingHint(RenderingHints.Key hintKey)

Forwards the call to the parent.

Specified by:

getRenderingHint in class Graphics2D

Parameters:

hintKey - the key corresponding to the hint to get.

Returns:

an object representing the value for the specified hint key. Some of the keys and their associated values are defined in the RenderingHints class.

setRenderingHints

public void setRenderingHints(Map hints)

Forwards the call to the parent.

Specified by:

setRenderingHints in class Graphics2D

Parameters:

hints - the rendering hints to be set

addRenderingHints

public void addRenderingHints(Map hints)

Forwards the call to the parent.

Specified by:

addRenderingHints in class Graphics2D

Parameters:

hints - the rendering hints to be set

getRenderingHints

public RenderingHints getRenderingHints()

Forwards the call to the parent.

Specified by:

getRenderingHints in class Graphics2D

Returns:

a reference to an instance of RenderingHints that contains the current preferences.

translate

public void translate(int x,
                      int y)

Forwards the call to the parent.

Specified by:

translate in class Graphics2D

Parameters:

x - coords.

y - the specified coordinates

Since:

JDK1.0

translate

public void translate(double tx,
                      double ty)

Concatenates the current Graphics2D Transform with a translation transform. Subsequent rendering is translated by the specified distance relative to the previous position. 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   ]
 

Specified by:

translate in class Graphics2D

Parameters:

tx - the distance to translate along the x-axis

ty - the distance to translate along the y-axis

rotate

public void rotate(double theta)

Concatenates the current Graphics2D Transform with a rotation transform. Subsequent rendering is rotated by the specified radians relative to the previous origin. 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.

Specified by:

rotate in class Graphics2D

Parameters:

theta - the angle of rotation in radians

rotate

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

Concatenates the current Graphics2D Transform with a translated rotation transform. Subsequent rendering is transformed by a transform which is constructed by translating to the specified location, rotating by the specified radians, and translating back by the same amount as the original translation. 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.

Specified by:

rotate in class Graphics2D

Parameters:

theta - the angle of rotation in radians

x - coords.

y - coordinates of the origin of the rotation

scale

public void scale(double sx,
                  double sy)

Concatenates the current Graphics2D Transform with a scaling transformation Subsequent rendering is resized according to the specified scaling factors relative to the previous scaling. 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   ]
 

Specified by:

scale in class Graphics2D

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.

shear

public void shear(double shx,
                  double shy)

Concatenates the current Graphics2D Transform with a shearing transform. Subsequent renderings are sheared by the specified multiplier relative to the previous position. 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   ]
 

Specified by:

shear in class Graphics2D

Parameters:

shx - the multiplier by which coordinates are shifted in the positive X axis direction as a function of their Y coordinate

shy - the multiplier by which coordinates are shifted in the positive Y axis direction as a function of their X coordinate

transform

public void transform(AffineTransform tx)

Composes an AffineTransform object with the Transform in this Graphics2D according to the rule last-specified-first-applied. If the current 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.

Specified by:

transform in class Graphics2D

Parameters:

tx - the AffineTransform object to be composed with the current Transform

See Also:

setTransform(java.awt.geom.AffineTransform), AffineTransform

setTransform

public void setTransform(AffineTransform tx)

Overwrites the Transform in the Graphics2D context. WARNING: This method should never be used to apply a new coordinate transform on top of an existing transform because the Graphics2D might already have a transform that is needed for other purposes, such as rendering Swing components or applying a scaling transformation to adjust for the resolution of a printer.

To add a coordinate transform, use the transform, rotate, scale, or shear methods. The setTransform method is intended only for restoring the original Graphics2D transform after rendering, as shown in this example:

 // Get the current transform
 AffineTransform saveAT = g2.getTransform();
 // Perform transformation
 g2d.transform(...);
 // Render
 g2d.draw(...);
 // Restore original transform
 g2d.setTransform(saveAT);
 

Specified by:

setTransform in class Graphics2D

Parameters:

tx - the AffineTransform that was retrieved from the getTransform method

See Also:

transform(java.awt.geom.AffineTransform), getTransform(), AffineTransform

getTransform

public AffineTransform getTransform()

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

Specified by:

getTransform in class Graphics2D

Returns:

the current AffineTransform in the Graphics2D context.

See Also:

transform(java.awt.geom.AffineTransform), setTransform(java.awt.geom.AffineTransform)

getPaint

public Paint getPaint()

Returns the current Paint of the Graphics2D context.

Specified by:

getPaint in class Graphics2D

Returns:

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

See Also:

setPaint(java.awt.Paint), Graphics.setColor(java.awt.Color)

getComposite

public Composite getComposite()

Returns the current Composite in the Graphics2D context.

Specified by:

getComposite in class Graphics2D

Returns:

the current Graphics2D Composite, which defines a compositing style.

See Also:

setComposite(java.awt.Composite)

setBackground

public void setBackground(Color color)

Sets the background color for the Graphics2D context. The background color is used for clearing a region. When a Graphics2D is constructed for a Component, the background 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.

Specified by:

setBackground in class Graphics2D

Parameters:

color - the background color that isused in subsequent calls to clearRect

See Also:

getBackground(), Graphics.clearRect(int, int, int, int)

getBackground

public Color getBackground()

Returns the background color used for clearing a region.

Specified by:

getBackground in class Graphics2D

Returns:

the current Graphics2D Color, which defines the background color.

See Also:

setBackground(java.awt.Color)

getStroke

public Stroke getStroke()

Returns the current Stroke in the Graphics2D context.

Specified by:

getStroke in class Graphics2D

Returns:

the current Graphics2D Stroke, which defines the line style.

See Also:

setStroke(java.awt.Stroke)

clip

public void clip(Shape s)

Intersects the current Clip with the interior of the specified Shape and sets the Clip to the resulting intersection. The specified Shape is transformed with the current Graphics2D Transform before being intersected with the current Clip. This method is used to make the current Clip smaller. To make the Clip larger, use setClip. The user clip modified by this method is independent of the clipping associated with device bounds and visibility. If no clip has previously been set, or if the clip has been cleared using setClip with a null argument, the specified Shape becomes the new user clip.

Specified by:

clip in class Graphics2D

Parameters:

s - the Shape to be intersected with the current Clip. If s is null, this method clears the current Clip.

getFontRenderContext

public FontRenderContext getFontRenderContext()

Get the rendering context of the Font within this Graphics2D context. The FontRenderContext encapsulates application hints such as anti-aliasing and fractional metrics, as well as target device specific information such as dots-per-inch. This information should be provided by the application when using objects that perform typographical formatting, such as Font and TextLayout. This information should also be provided by applications that perform their own layout and need accurate measurements of various characteristics of glyphs such as advance and line height when various rendering hints have been applied to the text rendering.

Specified by:

getFontRenderContext in class Graphics2D

Returns:

a reference to an instance of FontRenderContext.

Since:

1.2

See Also:

FontRenderContext, Font.createGlyphVector(java.awt.font.FontRenderContext, java.lang.String), TextLayout

create

public Graphics create()

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

Specified by:

create in class Graphics

Returns:

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

getColor

public Color getColor()

Gets this graphics context's current color.

Specified by:

getColor in class Graphics

Returns:

this graphics context's current color.

See Also:

Color, Graphics.setColor(Color)

setColor

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.

Specified by:

setColor in class Graphics

Parameters:

c - the new rendering color.

See Also:

Color, Graphics.getColor()

setPaintMode

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.

Specified by:

setPaintMode in class Graphics

setXORMode

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.

Specified by:

setXORMode in class Graphics

Parameters:

c1 - the XOR alternation color

getFont

public Font getFont()

Gets the current font.

Specified by:

getFont in class Graphics

Returns:

this graphics context's current font.

See Also:

Font, Graphics.setFont(Font)

setFont

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.

Specified by:

setFont in class Graphics

Parameters:

font - the font.

See Also:

Graphics.getFont(), Graphics.drawString(String, int, int), Graphics.drawBytes(byte[], int, int, int, int), Graphics.drawChars(char[], int, int, int, int)

getFontMetrics

public FontMetrics getFontMetrics(Font f)

Gets the font metrics for the specified font.

Specified by:

getFontMetrics in class Graphics

Parameters:

f - the specified font

Returns:

the font metrics for the specified font.

See Also:

Graphics.getFont(), FontMetrics, Graphics.getFontMetrics()

getClipBounds

public Rectangle getClipBounds()

Returns the bounding rectangle of the current clipping area. This method refers to the user clip, which is independent of the clipping associated with device bounds and window visibility. If no clip has previously been set, or if the clip has been cleared using setClip(null), this method returns null. The coordinates in the rectangle are relative to the coordinate system origin of this graphics context.

Specified by:

getClipBounds in class Graphics

Returns:

the bounding rectangle of the current clipping area, or null if no clip is set.

Since:

JDK1.1

See Also:

Graphics.getClip(), Graphics.clipRect(int, int, int, int), Graphics.setClip(int, int, int, int), Graphics.setClip(Shape)

clipRect

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. If there is no current clipping area, either because the clip has never been set, or the clip has been cleared using setClip(null), the specified rectangle becomes the new clip. This method sets the user clip, which is independent of the clipping associated with device bounds and window visibility. 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.

Specified by:

clipRect in class Graphics

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

See Also:

setClip(int, int, int, int), setClip(Shape)

setClip

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

Sets the current clip to the rectangle specified by the given coordinates. This method sets the user clip, which is independent of the clipping associated with device bounds and window visibility. Rendering operations have no effect outside of the clipping area.

Specified by:

setClip in class Graphics

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.

Since:

JDK1.1

See Also:

Graphics.clipRect(int, int, int, int), Graphics.setClip(Shape), Graphics.getClip()

getClip

public Shape getClip()

Gets the current clipping area. This method returns the user clip, which is independent of the clipping associated with device bounds and window visibility. If no clip has previously been set, or if the clip has been cleared using setClip(null), this method returns null.

Specified by:

getClip in class Graphics

Returns:

a Shape object representing the current clipping area, or null if no clip is set.

Since:

JDK1.1

See Also:

Graphics.getClipBounds(), Graphics.clipRect(int, int, int, int), Graphics.setClip(int, int, int, int), Graphics.setClip(Shape)

setClip

public void setClip(Shape clip)

Sets the current clipping area to an arbitrary clip shape. Not all objects that implement the Shape interface can be used to set the clip. The only Shape objects that are guaranteed to be supported are Shape objects that are obtained via the getClip method and via Rectangle objects. This method sets the user clip, which is independent of the clipping associated with device bounds and window visibility.

Specified by:

setClip in class Graphics

Parameters:

clip - the Shape to use to set the clip

Since:

JDK1.1

See Also:

Graphics.getClip(), Graphics.clipRect(int, int, int, int), Graphics.setClip(int, int, int, int)

copyArea

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.

Specified by:

copyArea in class Graphics

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.

drawLine

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.

Specified by:

drawLine in class Graphics

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.

fillRect

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.

Specified by:

fillRect in class Graphics

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.

See Also:

Graphics.clearRect(int, int, int, int), Graphics.drawRect(int, int, int, int)

clearRect

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.

Specified by:

clearRect in class Graphics

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.

See Also:

Graphics.fillRect(int, int, int, int), Graphics.drawRect(int, int, int, int), Graphics.setColor(Color), Graphics.setPaintMode(), Graphics.setXORMode(Color)

drawRoundRect

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.

Specified by:

drawRoundRect in class Graphics

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.

See Also:

Graphics.fillRoundRect(int, int, int, int, int, int)

fillRoundRect

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.

Specified by:

fillRoundRect in class Graphics

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.

See Also:

Graphics.drawRoundRect(int, int, int, int, int, int)

drawOval

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.

Specified by:

drawOval in class Graphics

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.

See Also:

Graphics.fillOval(int, int, int, int)

fillOval

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

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

Specified by:

fillOval in class Graphics

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.

See Also:

Graphics.drawOval(int, int, int, int)

drawArc

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 (x, y) 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.

The angles are specified relative to the non-square extents of the bounding rectangle such that 45 degrees always falls on the line from the center of the ellipse to the upper right corner of the bounding rectangle. As a result, if the bounding rectangle is noticeably longer in one axis than the other, the angles to the start and end of the arc segment will be skewed farther along the longer axis of the bounds.

Specified by:

drawArc in class Graphics

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.

See Also:

Graphics.fillArc(int, int, int, int, int, int)

fillArc

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 (x, y) 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.

The angles are specified relative to the non-square extents of the bounding rectangle such that 45 degrees always falls on the line from the center of the ellipse to the upper right corner of the bounding rectangle. As a result, if the bounding rectangle is noticeably longer in one axis than the other, the angles to the start and end of the arc segment will be skewed farther along the longer axis of the bounds.

Specified by:

fillArc in class Graphics

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.

See Also:

Graphics.drawArc(int, int, int, int, int, int)

drawPolyline

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 (x, y) coordinates defines a point. The figure is not closed if the first point differs from the last point.

Specified by:

drawPolyline in class Graphics

Parameters:

xPoints - an array of x points

yPoints - an array of y points

nPoints - the total number of points

Since:

JDK1.1

See Also:

Graphics.drawPolygon(int[], int[], int)

drawPolygon

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

Draws a closed polygon defined by arrays of x and y coordinates. Each pair of (x, y) 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.

Specified by:

drawPolygon in class Graphics

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.fillPolygon(int[], int[], int), Graphics.drawPolyline(int[], int[], int)

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.

Specified by:

fillPolygon in class Graphics

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)

drawImage

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 (x, y) 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.

Specified by:

drawImage in class Graphics

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:

true if the image is completely loaded; false otherwise.

See Also:

Image, ImageObserver, ImageObserver.imageUpdate(Image, int, int, int, int, int)

drawImage

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.

Specified by:

drawImage in class Graphics

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:

true if the current output representation is complete; false otherwise.

See Also:

Image, ImageObserver, ImageObserver.imageUpdate(Image, int, int, int, int, int)

drawImage

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 (x, y) 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.

Specified by:

drawImage in class Graphics

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:

true if the image is completely loaded; false otherwise.

See Also:

Image, ImageObserver, ImageObserver.imageUpdate(Image, int, int, int, int, int)

drawImage

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.

Specified by:

drawImage in class Graphics

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:

true if the current output representation is complete; false otherwise.

See Also:

Image, ImageObserver, ImageObserver.imageUpdate(Image, int, int, int, int, int)

drawImage

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.

Specified by:

drawImage in class Graphics

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:

true if the current output representation is complete; false otherwise.

Since:

JDK1.1

See Also:

Image, ImageObserver, ImageObserver.imageUpdate(Image, int, int, int, int, int)

drawImage

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.

Specified by:

drawImage in class Graphics

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:

true if the current output representation is complete; false otherwise.

Since:

JDK1.1

See Also:

Image, ImageObserver, ImageObserver.imageUpdate(Image, int, int, int, int, int)

dispose

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.

Specified by:

dispose in class Graphics

See Also:

Graphics.finalize(), Component.paint(java.awt.Graphics), Component.update(java.awt.Graphics), Component.getGraphics(), Graphics.create()

drawRect

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

Draws the outline of the specified rectangle. The left and right edges of the rectangle are at x and x + width. The top and bottom edges are at y and y + height. The rectangle is drawn using the graphics context's current color.

Overrides:

drawRect in class Graphics

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.

See Also:

Graphics.fillRect(int, int, int, int), Graphics.clearRect(int, int, int, int)

drawPolygon

public void drawPolygon(Polygon p)

Draws the outline of a polygon defined by the specified Polygon object.

Overrides:

drawPolygon in class Graphics

Parameters:

p - the polygon to draw.

See Also:

Graphics.fillPolygon(int[], int[], int), Graphics.drawPolyline(int[], int[], int)

fillPolygon

public void fillPolygon(Polygon p)

Fills the polygon defined by the specified Polygon object with the graphics context's current color.

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

Overrides:

fillPolygon in class Graphics

Parameters:

p - the polygon to fill.

See Also:

Graphics.drawPolygon(int[], int[], int)