File	Doc	Category	Size	Date	Package
Graphics2D.java	API Doc	Java SE 5 API	54750	Fri Aug 26 14:56:44 BST 2005	java.awt

Graphics2D

• java.lang.Object
  • java.awt.Graphics

Fields Summary

Constructors Summary

protected Graphics2D() Constructs a new Graphics2D object. Since Graphics2D is an abstract class, and since it must be customized by subclasses for different output devices, Graphics2D objects cannot be created directly. Instead, Graphics2D objects must be obtained from another Graphics2D object, created by a Component, or obtained from images such as {@link BufferedImage} objects. see java.awt.Component#getGraphics see java.awt.Graphics#create

Methods Summary
public abstract void	addRenderingHints(java.util.Map hints) Sets the values of an arbitrary number of preferences for the rendering algorithms. Only values for the rendering hints that are present in the specified Map object are modified. All other preferences not present in the specified object are left unmodified. Hint categories include controls for rendering quality and overall time/quality trade-off in the rendering process. Refer to the RenderingHints class for definitions of some common keys and values. param hints the rendering hints to be set see RenderingHints
public abstract void	clip(java.awt.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 {@link Graphics#setClip(Shape) setClip} with a null argument, the specified Shape becomes the new user clip. param s the Shape to be intersected with the current Clip. If s is null, this method clears the current Clip.
public abstract void	draw(java.awt.Shape s) Strokes the outline of a Shape using the settings of the current Graphics2D context. The rendering attributes applied include the Clip, Transform, Paint, Composite and Stroke attributes. param s the Shape to be rendered see #setStroke see #setPaint see java.awt.Graphics#setColor see #transform see #setTransform see #clip see #setClip see #setComposite
public void	draw3DRect(int x, int y, int width, int height, boolean raised) Draws a 3-D highlighted outline of the specified rectangle. The edges of the rectangle are highlighted so that they appear to be beveled and lit from the upper left corner. The colors used for the highlighting effect are determined based on the current color. The resulting rectangle covers an area that is width + 1 pixels wide by height + 1 pixels tall. This method uses the current Color exclusively and ignores the current Paint. param x the x coordinate of the rectangle to be drawn. param y the y coordinate of the rectangle to be drawn. param width the width of the rectangle to be drawn. param height the height of the rectangle to be drawn. param raised a boolean that determines whether the rectangle appears to be raised above the surface or sunk into the surface. see java.awt.Graphics#fill3DRect Paint p = getPaint(); Color c = getColor(); Color brighter = c.brighter(); Color darker = c.darker(); setColor(raised ? brighter : darker); //drawLine(x, y, x, y + height); fillRect(x, y, 1, height + 1); //drawLine(x + 1, y, x + width - 1, y); fillRect(x + 1, y, width - 1, 1); setColor(raised ? darker : brighter); //drawLine(x + 1, y + height, x + width, y + height); fillRect(x + 1, y + height, width, 1); //drawLine(x + width, y, x + width, y + height - 1); fillRect(x + width, y, 1, height); setPaint(p);
public abstract void	drawGlyphVector(java.awt.font.GlyphVector g, float x, float y) Renders the text of the specified {@link GlyphVector} using the Graphics2D context's rendering attributes. The rendering attributes applied include the Clip, Transform, Paint, and Composite attributes. The GlyphVector specifies individual glyphs from a {@link Font}. The GlyphVector can also contain the glyph positions. This is the fastest way to render a set of characters to the screen. param g the GlyphVector to be rendered param x the x position in User Space where the glyphs should be rendered param y the y position in User Space where the glyphs should be rendered see java.awt.Font#createGlyphVector see java.awt.font.GlyphVector see #setPaint see java.awt.Graphics#setColor see #setTransform see #setComposite see #setClip
public abstract boolean	drawImage(java.awt.Image img, java.awt.geom.AffineTransform xform, java.awt.image.ImageObserver obs) Renders 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 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. param img the specified image to be rendered. This method does nothing if img is null. param xform the transformation from image space into user space param obs the {@link ImageObserver} to be notified as more of the Image is converted return true if the Image is fully loaded and completely rendered, or if it's null; false if the Image is still being loaded. see #transform see #setTransform see #setComposite see #clip see #setClip
public abstract void	drawImage(java.awt.image.BufferedImage img, java.awt.image.BufferedImageOp op, int x, int y) Renders a BufferedImage that is filtered with a {@link 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); param op the filter to be applied to the image before rendering param img the specified BufferedImage to be rendered. This method does nothing if img is null. param x the x coordinate of the location in user space where the upper left corner of the image is rendered param y the y coordinate of the location in user space where the upper left corner of the image is rendered see #transform see #setTransform see #setComposite see #clip see #setClip
public abstract void	drawRenderableImage(java.awt.image.renderable.RenderableImage img, java.awt.geom.AffineTransform xform) Renders a {@link 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 {@link #drawRenderedImage(RenderedImage, AffineTransform) drawRenderedImage}. param img the image to be rendered. This method does nothing if img is null. param xform the transformation from image space into user space see #transform see #setTransform see #setComposite see #clip see #setClip see #drawRenderedImage
public abstract void	drawRenderedImage(java.awt.image.RenderedImage img, java.awt.geom.AffineTransform xform) Renders a {@link RenderedImage}, 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. param img the image to be rendered. This method does nothing if img is null. param xform the transformation from image space into user space see #transform see #setTransform see #setComposite see #clip see #setClip
public abstract void	drawString(java.lang.String s, float x, float y) Renders the text specified by the specified String, using the current text attribute state in the Graphics2D context. The baseline of the first character is at position (x, y) in the User Space. The rendering attributes applied include the Clip, Transform, Paint, Font and Composite attributes. For characters in script systems such as Hebrew and Arabic, the glyphs can be rendered from right to left, in which case the coordinate supplied is the location of the leftmost character on the baseline. param s the String to be rendered param x the x coordinate of the location where the String should be rendered param y the y coordinate of the location where the String should be rendered throws NullPointerException if str is null see #setPaint see java.awt.Graphics#setColor see java.awt.Graphics#setFont see #setTransform see #setComposite see #setClip
public abstract void	drawString(java.text.AttributedCharacterIterator iterator, int x, int y) Renders the text of the specified iterator, using the Graphics2D context's current Paint. The iterator has to specify a font for each character. The baseline of the first character is at position (x, y) in the User Space. The rendering attributes applied include the Clip, Transform, Paint, and Composite attributes. For characters in script systems such as Hebrew and Arabic, the glyphs can be rendered from right to left, in which case the coordinate supplied is the location of the leftmost character on the baseline. param iterator the iterator whose text is to be rendered param x the x coordinate where the iterator's text is to be rendered param y the y coordinate where the iterator's text is to be rendered see #setPaint see java.awt.Graphics#setColor see #setTransform see #setComposite see #setClip
public abstract void	drawString(java.text.AttributedCharacterIterator iterator, float x, float y) Renders the text of the specified iterator, using the Graphics2D context's current Paint. The iterator must specify a font for each character. The baseline of the first character is at position (x, y) in the User Space. The rendering attributes applied include the Clip, Transform, Paint, and Composite attributes. For characters in script systems such as Hebrew and Arabic, the glyphs can be rendered from right to left, in which case the coordinate supplied is the location of the leftmost character on the baseline. param iterator the iterator whose text is to be rendered param x the x coordinate where the iterator's text is to be rendered param y the y coordinate where the iterator's text is to be rendered see #setPaint see java.awt.Graphics#setColor see #setTransform see #setComposite see #setClip
public abstract void	drawString(java.lang.String str, int x, int y) Renders the text of the specified String, using the current text attribute state in the Graphics2D context. The baseline of the first character is at position (x, y) in the User Space. The rendering attributes applied include the Clip, Transform, Paint, Font and Composite attributes. For characters in script systems such as Hebrew and Arabic, the glyphs can be rendered from right to left, in which case the coordinate supplied is the location of the leftmost character on the baseline. param str the string to be rendered param x the x coordinate of the location where the String should be rendered param y the y coordinate of the location where the String should be rendered throws NullPointerException if str is null see java.awt.Graphics#drawBytes see java.awt.Graphics#drawChars since JDK1.0
public abstract void	fill(java.awt.Shape s) Fills the interior of a Shape using the settings of the Graphics2D context. The rendering attributes applied include the Clip, Transform, Paint, and Composite. param s the Shape to be filled see #setPaint see java.awt.Graphics#setColor see #transform see #setTransform see #setComposite see #clip see #setClip
public void	fill3DRect(int x, int y, int width, int height, boolean raised) Paints a 3-D highlighted rectangle filled with the current color. The edges of the rectangle are highlighted so that it appears as if the edges were beveled and lit from the upper left corner. The colors used for the highlighting effect and for filling are determined from the current Color. This method uses the current Color exclusively and ignores the current Paint. param x the x coordinate of the rectangle to be filled. param y the y coordinate of the rectangle to be filled. param width the width of the rectangle to be filled. param height the height of the rectangle to be filled. param raised a boolean value that determines whether the rectangle appears to be raised above the surface or etched into the surface. see java.awt.Graphics#draw3DRect Paint p = getPaint(); Color c = getColor(); Color brighter = c.brighter(); Color darker = c.darker(); if (!raised) { setColor(darker); } else if (p != c) { setColor(c); } fillRect(x+1, y+1, width-2, height-2); setColor(raised ? brighter : darker); //drawLine(x, y, x, y + height - 1); fillRect(x, y, 1, height); //drawLine(x + 1, y, x + width - 2, y); fillRect(x + 1, y, width - 2, 1); setColor(raised ? darker : brighter); //drawLine(x + 1, y + height - 1, x + width - 1, y + height - 1); fillRect(x + 1, y + height - 1, width - 1, 1); //drawLine(x + width - 1, y, x + width - 1, y + height - 2); fillRect(x + width - 1, y, 1, height - 1); setPaint(p);
public abstract java.awt.Color	getBackground() Returns the background color used for clearing a region. return the current Graphics2D Color, which defines the background color. see #setBackground
public abstract java.awt.Composite	getComposite() Returns the current Composite in the Graphics2D context. return the current Graphics2D Composite, which defines a compositing style. see #setComposite
public abstract java.awt.GraphicsConfiguration	getDeviceConfiguration() Returns the device configuration associated with this Graphics2D. return the device configuration of this Graphics2D.
public abstract java.awt.font.FontRenderContext	getFontRenderContext() Get the rendering context of the Font within this Graphics2D context. The {@link 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. return a reference to an instance of FontRenderContext. see java.awt.font.FontRenderContext see java.awt.Font#createGlyphVector see java.awt.font.TextLayout since 1.2
public abstract java.awt.Paint	getPaint() Returns the current Paint of the Graphics2D context. return the current Graphics2D Paint, which defines a color or pattern. see #setPaint see java.awt.Graphics#setColor
public abstract java.lang.Object	getRenderingHint(java.awt.RenderingHints.Key hintKey) Returns the value of a single preference for the rendering algorithms. Hint categories include controls for rendering quality and overall time/quality trade-off in the rendering process. Refer to the RenderingHints class for definitions of some common keys and values. param hintKey the key corresponding to the hint to get. return an object representing the value for the specified hint key. Some of the keys and their associated values are defined in the RenderingHints class. see RenderingHints see #setRenderingHint(RenderingHints.Key, Object)
public abstract java.awt.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 all of the hint key/value pairs that were ever specified in one operation. Refer to the RenderingHints class for definitions of some common keys and values. return a reference to an instance of RenderingHints that contains the current preferences. see RenderingHints see #setRenderingHints(Map)
public abstract java.awt.Stroke	getStroke() Returns the current Stroke in the Graphics2D context. return the current Graphics2D Stroke, which defines the line style. see #setStroke
public abstract java.awt.geom.AffineTransform	getTransform() Returns a copy of the current Transform in the Graphics2D context. return the current AffineTransform in the Graphics2D context. see #transform see #setTransform
public abstract boolean	hit(java.awt.Rectangle rect, java.awt.Shape s, boolean onStroke) Checks whether or not the specified Shape intersects the specified {@link Rectangle}, which is in device space. If onStroke is false, this method checks whether or not the interior of the specified Shape intersects the specified Rectangle. If onStroke is true, this method checks whether or not the Stroke of the specified Shape outline intersects the specified Rectangle. The rendering attributes taken into account include the Clip, Transform, and Stroke attributes. param rect the area in device space to check for a hit param s the Shape to check for a hit param 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. return true if there is a hit; false otherwise. see #setStroke see #fill see #draw see #transform see #setTransform see #clip see #setClip
public abstract 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. param theta the angle of rotation in radians
public abstract 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. param theta the angle of rotation in radians param x the x coordinate of the origin of the rotation param y the y coordinate of the origin of the rotation
public abstract 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 ] param sx the amount by which X coordinates in subsequent rendering operations are multiplied relative to previous rendering operations. param sy the amount by which Y coordinates in subsequent rendering operations are multiplied relative to previous rendering operations.
public abstract void	setBackground(java.awt.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. param color the background color that isused in subsequent calls to clearRect see #getBackground see java.awt.Graphics#clearRect
public abstract void	setComposite(java.awt.Composite comp) Sets the Composite for the Graphics2D context. The 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 during the rendering process. If this Graphics2D context is drawing to a Component on the display screen and the Composite is a custom object rather than an instance of the AlphaComposite class, and if there is a security manager, its checkPermission method is called with an AWTPermission("readDisplayPixels") permission. 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. param comp the Composite object to be used for rendering see java.awt.Graphics#setXORMode see java.awt.Graphics#setPaintMode see #getComposite see AlphaComposite see SecurityManager#checkPermission see java.awt.AWTPermission
public abstract void	setPaint(java.awt.Paint paint) Sets the Paint attribute for the Graphics2D context. Calling this method with a null Paint object does not have any effect on the current Paint attribute of this Graphics2D. param paint the Paint object to be used to generate color during the rendering process, or null see java.awt.Graphics#setColor see #getPaint see GradientPaint see TexturePaint
public abstract void	setRenderingHint(java.awt.RenderingHints.Key hintKey, java.lang.Object hintValue) Sets the value of a single preference for the rendering algorithms. Hint categories include controls for rendering quality and overall time/quality trade-off in the rendering process. Refer to the RenderingHints class for definitions of some common keys and values. param hintKey the key of the hint to be set. param hintValue the value indicating preferences for the specified hint category. see #getRenderingHint(RenderingHints.Key) see RenderingHints
public abstract void	setRenderingHints(java.util.Map hints) Replaces the values of all preferences for the rendering algorithms with the specified hints. The existing values for all rendering hints are discarded and the new set of known hints and values are initialized from the specified {@link Map} object. Hint categories include controls for rendering quality and overall time/quality trade-off in the rendering process. Refer to the RenderingHints class for definitions of some common keys and values. param hints the rendering hints to be set see #getRenderingHints see RenderingHints
public abstract void	setStroke(java.awt.Stroke s) Sets the Stroke for the Graphics2D context. param s the Stroke object to be used to stroke a Shape during the rendering process see BasicStroke see #getStroke
public abstract void	setTransform(java.awt.geom.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); param Tx the AffineTransform that was retrieved from the getTransform method see #transform see #getTransform see AffineTransform
public abstract 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 ] param shx the multiplier by which coordinates are shifted in the positive X axis direction as a function of their Y coordinate param shy the multiplier by which coordinates are shifted in the positive Y axis direction as a function of their X coordinate
public abstract void	transform(java.awt.geom.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. param Tx the AffineTransform object to be composed with the current Transform see #setTransform see AffineTransform
public abstract void	translate(int x, int y) Translates the origin of the Graphics2D context to the point (x, y) in the current coordinate system. Modifies the Graphics2D context so that its new origin corresponds to the point (x, y) in the Graphics2D context's former coordinate system. All coordinates used in subsequent rendering operations on this graphics context are relative to this new origin. param x the specified x coordinate param y the specified y coordinate since JDK1.0
public abstract 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 ] param tx the distance to translate along the x-axis param ty the distance to translate along the y-axis