java::awt::Graphics Class Reference

Inheritance diagram for java::awt::Graphics:

Inheritance graph
java::lang::Object
[legend]
Collaboration diagram for java::awt::Graphics:

Collaboration graph
java::lang::Object
[legend]

List of all members.


Detailed Description

The Graphics class is the abstract base class for all graphics contexts that allow an application to draw onto components that are realized on various devices, as well as onto off-screen images.

A Graphics object encapsulates state information needed for the basic rendering operations that Java supports. This state information includes the following properties:

Coordinates are infinitely thin and lie between the pixels of the output device. Operations that draw the outline of a figure operate by traversing an infinitely thin path between pixels with a pixel-sized pen that hangs down and to the right of the anchor point on the path. Operations that fill a figure operate by filling the interior of that infinitely thin path. Operations that render horizontal text render the ascending portion of character glyphs entirely above the baseline coordinate.

The graphics pen hangs down and to the right from the path it traverses. This has the following implications:

All coordinates that appear as arguments to the methods of this Graphics object are considered relative to the translation origin of this Graphics object prior to the invocation of the method.

All rendering operations modify only pixels which lie within the area bounded by the current clip, which is specified by a Shape in user space and is controlled by the program using the Graphics object. This user clip is transformed into device space and combined with the device clip, which is defined by the visibility of windows and device extents. The combination of the user clip and device clip defines the composite clip, which determines the final clipping region. The user clip cannot be modified by the rendering system to reflect the resulting composite clip. The user clip can only be changed through the setClip or clipRect methods. All drawing or writing is done in the current color, using the current paint mode, and in the current font.

Version:
1.65, 01/23/03
Author:
Sami Shaio

Arthur van Hoff

See also:
java.awt.Component

java.awt.Graphics::clipRect(int, int, int, int)

java.awt.Graphics::setColor(java.awt.Color)

java.awt.Graphics::setPaintMode()

java.awt.Graphics::setXORMode(java.awt.Color)

java.awt.Graphics::setFont(java.awt.Font)

Since:
JDK1.0

Public Member Functions

virtual Ref< Graphicscreate () const =0
 Creates a new Graphics object that is a copy of this Graphics object.
virtual Ref< Graphicscreate (jint x, jint y, jint width, jint height) const
 Creates a new Graphics object based on this Graphics object, but with a new translation and clip area.
virtual void translate (jint x, jint y)=0
 Translates the origin of the graphics context to the point (xy) in the current coordinate system.
virtual Ref< ColorgetColor () const =0
 Gets this graphics context's current color.
virtual void setColor (const Ref< Color > &c)=0
 Sets this graphics context's current color to the specified color.
virtual Ref< ColorgetBkColor () const =0
 Gets this graphics context's current background color.
virtual void setBkColor (const Ref< Color > &c)=0
 Sets this graphics context's current background color to the specified color.
virtual void setPaintMode ()=0
 Sets the paint mode of this graphics context to overwrite the destination with this graphics context's current color.
virtual void setXORMode (const Ref< Color > &c)=0
 Sets the paint mode of this graphics context to alternate between this graphics context's current color and the new specified color.
virtual Ref< FontgetFont () const =0
 Gets the current font.
virtual void setFont (const Ref< Font > &font)=0
 Sets this graphics context's font to the specified font.
virtual Ref
< FontMetrics
getFontMetrics (const Ref< Font > &f=0) const =0
 Gets the font metrics for the specified font.
virtual Rectangle getClipBounds () const =0
 Returns the bounding rectangle of the current clipping area.
virtual void clipRect (jint x, jint y, jint width, jint height)=0
 Intersects the current clip with the specified rectangle.
virtual void setClip (jint x, jint y, jint width, jint height)=0
 Sets the current clip to the rectangle specified by the given coordinates.
virtual Ref< ShapegetClip () const =0
 Gets the current clipping area.
virtual void setClip (const Ref< Shape > &clip)=0
 Sets the current clipping area to an arbitrary clip shape.
virtual void copyArea (jint x, jint y, jint width, jint height, jint dx, jint dy)=0
 Copies an area of the component by a distance specified by dx and dy.
virtual void drawLine (jint x1, jint y1, jint x2, jint y2)=0
 Draws a line, using the current color, between the points (x1, y1) and (x2, y2) in this graphics context's coordinate system.
virtual void fillRect (jint x, jint y, jint width, jint height)=0
 Fills the specified rectangle.
virtual void drawRect (jint x, jint y, jint width, jint height)
 Draws the outline of the specified rectangle.
virtual void clearRect (jint x, jint y, jint width, jint height)=0
 Clears the specified rectangle by filling it with the background color of the current drawing surface.
virtual void drawRoundRect (jint x, jint y, jint width, jint height, jint arcWidth, jint arcHeight)=0
 Draws an outlined round-cornered rectangle using this graphics context's current color.
virtual void fillRoundRect (jint x, jint y, jint width, jint height, jint arcWidth, jint arcHeight)=0
 Fills the specified rounded corner rectangle with the current color.
virtual void draw3DRect (jint x, jint y, jint width, jint height, jboolean raised)
 Draws a 3-D highlighted outline of the specified rectangle.
virtual void fill3DRect (jint x, jint y, jint width, jint height, jboolean raised)
 Paints a 3-D highlighted rectangle filled with the current color.
virtual void drawOval (jint x, jint y, jint width, jint height)=0
 Draws the outline of an oval.
virtual void fillOval (jint x, jint y, jint width, jint height)=0
 Fills an oval bounded by the specified rectangle with the current color.
virtual void drawArc (jint x, jint y, jint width, jint height, jint startAngle, jint arcAngle)=0
 Draws the outline of a circular or elliptical arc covering the specified rectangle.
virtual void fillArc (jint x, jint y, jint width, jint height, jint startAngle, jint arcAngle)=0
 Fills a circular or elliptical arc covering the specified rectangle.
virtual void drawPolyline (const Array< Point > &ps)=0
 Draws a sequence of connected lines defined by arrays of x and y coordinates.
virtual void drawPolygon (const Array< Point > &ps)=0
 Draws a closed polygon defined by arrays of x and y coordinates.
virtual void fillPolygon (const Array< Point > &ps)=0
 Fills a closed polygon defined by arrays of x and y coordinates.
virtual void drawString (const String &str, jint x, jint y)=0
 Draws the text given by the specified string, using this graphics context's current font and color.
virtual void drawString (const AttributedCharacterIterator &iter, jint x, jint y)=0
 Draws the text given by the specified iterator, using this graphics context's current color.
virtual jboolean drawImage (const Ref< Image > &img, jint x, jint y, const Ref< ImageObserver > &observer, const Ref< Color > &bgColor=0)=0
 Draws as much of the specified image as is currently available.
virtual jboolean drawImage (const Ref< Image > &img, jint x, jint y, jint width, jint height, const Ref< ImageObserver > &observer, const Ref< Color > &bgColor=0)=0
 Draws as much of the specified image as has already been scaled to fit inside the specified rectangle.
virtual jboolean drawImage (const Ref< Image > &img, jint dx1, jint dy1, jint dx2, jint dy2, jint sx1, jint sy1, jint sx2, jint sy2, const Ref< ImageObserver > &observer, const Ref< Color > &bgColor=0)=0
 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.
virtual void dispose ()=0
 Disposes of this graphics context and releases any system resources that it is using.
virtual jboolean hitClip (jint x, jint y, jint width, jint height) const
 Returns true if the specified rectangular area might intersect the current clipping area.
virtual String toString () const
 Returns a String object representing this Graphics object's value.

Member Function Documentation

virtual Ref<Graphics> java::awt::Graphics::create (  )  const [pure virtual]

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.

virtual Ref<Graphics> java::awt::Graphics::create ( jint  x,
jint  y,
jint  width,
jint  height 
) const [virtual]

Creates a new Graphics object based on this Graphics object, but with a new translation and clip area.

The new Graphics object has its origin translated to the specified point (xy). Its clip area is determined by the intersection of the original clip area with the specified rectangle. The arguments are all interpreted in the coordinate system of the original Graphics object. The new graphics context is identical to the original, except in two respects:

Parameters:
x the x coordinate.
y the y coordinate.
width the width of the clipping rectangle.
height the height of the clipping rectangle.
Returns:
a new graphics context.
See also:
java.awt.Graphics::translate

java.awt.Graphics::clipRect

virtual void java::awt::Graphics::translate ( jint  x,
jint  y 
) [pure virtual]

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.

virtual Ref<Color> java::awt::Graphics::getColor (  )  const [pure virtual]

Gets this graphics context's current color.

Returns:
this graphics context's current color.
See also:
java.awt.Color

java.awt.Graphics::setColor(Color)

virtual void java::awt::Graphics::setColor ( const Ref< Color > &  c  )  [pure virtual]

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:
java.awt.Color

java.awt.Graphics::getColor

virtual Ref<Color> java::awt::Graphics::getBkColor (  )  const [pure virtual]

Gets this graphics context's current background color.

Returns:
this graphics context's current background color.
See also:
java.awt.Color

virtual void java::awt::Graphics::setBkColor ( const Ref< Color > &  c  )  [pure virtual]

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

All subsequent graphics operations using this graphics context use this specified background color.

Parameters:
c the new background color.
See also:
java.awt.Color

virtual void java::awt::Graphics::setPaintMode (  )  [pure virtual]

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.

virtual void java::awt::Graphics::setXORMode ( const Ref< Color > &  c  )  [pure virtual]

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

virtual Ref<Font> java::awt::Graphics::getFont (  )  const [pure virtual]

Gets the current font.

Returns:
this graphics context's current font.
See also:
java.awt.Font

java.awt.Graphics::setFont(Font)

virtual void java::awt::Graphics::setFont ( const Ref< Font > &  font  )  [pure virtual]

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:
java.awt.Graphics::getFont

java.awt.Graphics::drawString(java.lang.String, int, int)

java.awt.Graphics::drawBytes(byte[], int, int, int, int)

java.awt.Graphics::drawChars(char[], int, int, int, int)

virtual Ref<FontMetrics> java::awt::Graphics::getFontMetrics ( const Ref< Font > &  f = 0  )  const [pure virtual]

Gets the font metrics for the specified font.

Returns:
the font metrics for the specified font.
Parameters:
f the specified font
See also:
java.awt.Graphics::getFont

java.awt.FontMetrics

java.awt.Graphics::getFontMetrics()

virtual Rectangle java::awt::Graphics::getClipBounds (  )  const [pure virtual]

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.

Returns:
the bounding rectangle of the current clipping area, or null if no clip is set.
See also:
java.awt.Graphics::getClip

java.awt.Graphics::clipRect

java.awt.Graphics::setClip(int, int, int, int)

java.awt.Graphics::setClip(Shape)

Since:
JDK1.1

virtual void java::awt::Graphics::clipRect ( jint  x,
jint  y,
jint  width,
jint  height 
) [pure virtual]

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.

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)

virtual void java::awt::Graphics::setClip ( jint  x,
jint  y,
jint  width,
jint  height 
) [pure virtual]

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.

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.
See also:
java.awt.Graphics::clipRect

java.awt.Graphics::setClip(Shape)

java.awt.Graphics::getClip

Since:
JDK1.1

virtual Ref<Shape> java::awt::Graphics::getClip (  )  const [pure virtual]

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.

Returns:
a Shape object representing the current clipping area, or null if no clip is set.
See also:
java.awt.Graphics::getClipBounds

java.awt.Graphics::clipRect

java.awt.Graphics::setClip(int, int, int, int)

java.awt.Graphics::setClip(Shape)

Since:
JDK1.1

virtual void java::awt::Graphics::setClip ( const Ref< Shape > &  clip  )  [pure virtual]

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.

Parameters:
clip the Shape to use to set the clip
See also:
java.awt.Graphics::getClip()

java.awt.Graphics::clipRect

java.awt.Graphics::setClip(int, int, int, int)

Since:
JDK1.1

virtual void java::awt::Graphics::copyArea ( jint  x,
jint  y,
jint  width,
jint  height,
jint  dx,
jint  dy 
) [pure virtual]

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.

virtual void java::awt::Graphics::drawLine ( jint  x1,
jint  y1,
jint  x2,
jint  y2 
) [pure virtual]

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.

virtual void java::awt::Graphics::fillRect ( jint  x,
jint  y,
jint  width,
jint  height 
) [pure virtual]

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.
See also:
java.awt.Graphics::clearRect

java.awt.Graphics::drawRect

virtual void java::awt::Graphics::drawRect ( jint  x,
jint  y,
jint  width,
jint  height 
) [virtual]

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.

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:
java.awt.Graphics::fillRect

java.awt.Graphics::clearRect

virtual void java::awt::Graphics::clearRect ( jint  x,
jint  y,
jint  width,
jint  height 
) [pure virtual]

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.
See also:
java.awt.Graphics::fillRect(int, int, int, int)

java.awt.Graphics::drawRect

java.awt.Graphics::setColor(java.awt.Color)

java.awt.Graphics::setPaintMode

java.awt.Graphics::setXORMode(java.awt.Color)

virtual void java::awt::Graphics::drawRoundRect ( jint  x,
jint  y,
jint  width,
jint  height,
jint  arcWidth,
jint  arcHeight 
) [pure virtual]

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.
See also:
java.awt.Graphics::fillRoundRect

virtual void java::awt::Graphics::fillRoundRect ( jint  x,
jint  y,
jint  width,
jint  height,
jint  arcWidth,
jint  arcHeight 
) [pure virtual]

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.
See also:
java.awt.Graphics::drawRoundRect

virtual void java::awt::Graphics::draw3DRect ( jint  x,
jint  y,
jint  width,
jint  height,
jboolean  raised 
) [virtual]

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.

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.
raised a boolean that determines whether the rectangle appears to be raised above the surface or sunk into the surface.
See also:
java.awt.Graphics::fill3DRect

virtual void java::awt::Graphics::fill3DRect ( jint  x,
jint  y,
jint  width,
jint  height,
jboolean  raised 
) [virtual]

Paints a 3-D highlighted rectangle filled with the current color.

The edges of the rectangle will be 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 will be determined from the 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.
raised a boolean value that determines whether the rectangle appears to be raised above the surface or etched into the surface.
See also:
java.awt.Graphics::draw3DRect

virtual void java::awt::Graphics::drawOval ( jint  x,
jint  y,
jint  width,
jint  height 
) [pure virtual]

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.
See also:
java.awt.Graphics::fillOval

virtual void java::awt::Graphics::fillOval ( jint  x,
jint  y,
jint  width,
jint  height 
) [pure virtual]

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.
See also:
java.awt.Graphics::drawOval

virtual void java::awt::Graphics::drawArc ( jint  x,
jint  y,
jint  width,
jint  height,
jint  startAngle,
jint  arcAngle 
) [pure virtual]

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.

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.

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:
java.awt.Graphics::fillArc

virtual void java::awt::Graphics::fillArc ( jint  x,
jint  y,
jint  width,
jint  height,
jint  startAngle,
jint  arcAngle 
) [pure virtual]

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.

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.

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:
java.awt.Graphics::drawArc

virtual void java::awt::Graphics::drawPolyline ( const Array< Point > &  ps  )  [pure virtual]

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:
ps an array of Point points
Since:
JDK1.1

virtual void java::awt::Graphics::drawPolygon ( const Array< Point > &  ps  )  [pure virtual]

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:
ps a an array of Point coordinates.
See also:
java.awt.Graphics::fillPolygon

java.awt.Graphics::drawPolyline

virtual void java::awt::Graphics::fillPolygon ( const Array< Point > &  ps  )  [pure virtual]

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:
ps a an array of Point coordinates.

virtual void java::awt::Graphics::drawString ( const String str,
jint  x,
jint  y 
) [pure virtual]

Draws the text given by the specified string, using this graphics context's current font and color.

The baseline of the leftmost 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.
See also:
java.awt.Graphics::drawBytes

java.awt.Graphics::drawChars

virtual void java::awt::Graphics::drawString ( const AttributedCharacterIterator iter,
jint  x,
jint  y 
) [pure virtual]

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 leftmost character is at position (xy) in this graphics context's coordinate system.

Parameters:
iterator the iterator whose text is to be drawn
x the x coordinate.
y the y coordinate.
See also:
java.awt.Graphics::drawBytes

java.awt.Graphics::drawChars

virtual jboolean java::awt::Graphics::drawImage ( const Ref< Image > &  img,
jint  x,
jint  y,
const Ref< ImageObserver > &  observer,
const Ref< Color > &  bgColor = 0 
) [pure virtual]

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.
observer object to be notified as more of the image is converted.
bgcolor the background color to paint under the non-opaque portions of the image.
Returns:
true if the image is completely loaded; false otherwise.
See also:
java.awt.Image

java.awt.image.ImageObserver

java.awt.image.ImageObserver::imageUpdate(java.awt.Image, int, int, int, int, int)

virtual jboolean java::awt::Graphics::drawImage ( const Ref< Image > &  img,
jint  x,
jint  y,
jint  width,
jint  height,
const Ref< ImageObserver > &  observer,
const Ref< Color > &  bgColor = 0 
) [pure virtual]

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.
observer object to be notified as more of the image is converted.
bgcolor the background color to paint under the non-opaque portions of the image.
Returns:
true if the current output representation is complete; false otherwise.
See also:
java.awt.Image

java.awt.image.ImageObserver

java.awt.image.ImageObserver::imageUpdate(java.awt.Image, int, int, int, int, int)

virtual jboolean java::awt::Graphics::drawImage ( const Ref< Image > &  img,
jint  dx1,
jint  dy1,
jint  dx2,
jint  dy2,
jint  sx1,
jint  sy1,
jint  sx2,
jint  sy2,
const Ref< ImageObserver > &  observer,
const Ref< Color > &  bgColor = 0 
) [pure virtual]

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:
true if the current output representation is complete; false otherwise.
See also:
java.awt.Image

java.awt.image.ImageObserver

java.awt.image.ImageObserver::imageUpdate(java.awt.Image, int, int, int, int, int)

Since:
JDK1.1

virtual void java::awt::Graphics::dispose (  )  [pure virtual]

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.

See also:
java.awt.Graphics::finalize

java.awt.Component::paint

java.awt.Component::update

java.awt.Component::getGraphics

java.awt.Graphics::create

virtual jboolean java::awt::Graphics::hitClip ( jint  x,
jint  y,
jint  width,
jint  height 
) const [virtual]

Returns true if the specified rectangular area might intersect the current clipping area.

The coordinates of the specified rectangular area are in the user coordinate space and are relative to the coordinate system origin of this graphics context. This method may use an algorithm that calculates a result quickly but which sometimes might return true even if the specified rectangular area does not intersect the clipping area. The specific algorithm employed may thus trade off accuracy for speed, but it will never return false unless it can guarantee that the specified rectangular area does not intersect the current clipping area. The clipping area used by this method can represent the intersection of the user clip as specified through the clip methods of this graphics context as well as the clipping associated with the device or image bounds and window visibility.

Parameters:
x the x coordinate of the rectangle to test against the clip
y the y coordinate of the rectangle to test against the clip
width the width of the rectangle to test against the clip
height the height of the rectangle to test against the clip
Returns:
true if the specified rectangle intersects the bounds of the current clip; false otherwise.

virtual String java::awt::Graphics::toString (  )  const [virtual]

Returns a String object representing this Graphics object's value.

Returns:
a string representation of this graphics context.

Reimplemented from java::lang::Object.


The documentation for this class was generated from the following file:
Generated on Fri May 16 11:56:00 2008 for CrossPlatformJavaLikeC++API by  doxygen 1.5.3