DebugGraphics (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.swing
class DebugGraphics

java.lang.Object
  java.awt.Graphics
      javax.swing.DebugGraphics

public class DebugGraphics
extends Graphics

Graphics subclass supporting graphics debugging. Overrides most methods from Graphics. DebugGraphics objects are rarely created by hand. They are most frequently created automatically when a JComponent's debugGraphicsOptions are changed using the setDebugGraphicsOptions() method.

NOTE: You must turn off double buffering to use DebugGraphics: RepaintManager repaintManager = RepaintManager.currentManager(component); repaintManager.setDoubleBufferingEnabled(false);

Field Summary
`static int`	`BUFFERED_OPTION` Show buffered operations in a separate `Frame`.
`static int`	`FLASH_OPTION` Flash graphics operations.
`static int`	`LOG_OPTION` Log graphics operations.
`static int`	`NONE_OPTION` Don't debug graphics operations.

Constructor Summary
`DebugGraphics()` Constructs a new debug graphics context that supports slowed down drawing.
`DebugGraphics(Graphics graphics)` Constructs a debug graphics context from an existing graphics context that supports slowed down drawing.
`DebugGraphics(Graphics graphics, JComponent component)` Constructs a debug graphics context from an existing graphics context that slows down drawing for the specified component.

Method Summary
`void`	`clearRect(int x, int y, int width, int height)` Overrides `Graphics.clearRect`.
`void`	`clipRect(int x, int y, int width, int height)` Overrides `Graphics.clipRect`.
`void`	`copyArea(int x, int y, int width, int height, int destX, int destY)` Overrides `Graphics.copyArea`.
`Graphics`	`create()` Overrides `Graphics.create` to return a DebugGraphics object.
`Graphics`	`create(int x, int y, int width, int height)` Overrides `Graphics.create` to return a DebugGraphics object.
`void`	`dispose()` Overrides `Graphics.dispose`.
`void`	`draw3DRect(int x, int y, int width, int height, boolean raised)` Overrides `Graphics.draw3DRect`.
`void`	`drawArc(int x, int y, int width, int height, int startAngle, int arcAngle)` Overrides `Graphics.drawArc`.
`void`	`drawBytes(byte[] data, int offset, int length, int x, int y)` Overrides `Graphics.drawBytes`.
`void`	`drawChars(char[] data, int offset, int length, int x, int y)` Overrides `Graphics.drawChars`.
`boolean`	`drawImage(Image img, int x, int y, Color bgcolor, ImageObserver observer)` Overrides `Graphics.drawImage`.
`boolean`	`drawImage(Image img, int x, int y, ImageObserver observer)` Overrides `Graphics.drawImage`.
`boolean`	`drawImage(Image img, int x, int y, int width, int height, Color bgcolor, ImageObserver observer)` Overrides `Graphics.drawImage`.
`boolean`	`drawImage(Image img, int x, int y, int width, int height, ImageObserver observer)` Overrides `Graphics.drawImage`.
`boolean`	`drawImage(Image img, int dx1, int dy1, int dx2, int dy2, int sx1, int sy1, int sx2, int sy2, Color bgcolor, ImageObserver observer)` Overrides `Graphics.drawImage`.
`boolean`	`drawImage(Image img, int dx1, int dy1, int dx2, int dy2, int sx1, int sy1, int sx2, int sy2, ImageObserver observer)` Overrides `Graphics.drawImage`.
`void`	`drawLine(int x1, int y1, int x2, int y2)` Overrides `Graphics.drawLine`.
`void`	`drawOval(int x, int y, int width, int height)` Overrides `Graphics.drawOval`.
`void`	`drawPolygon(int[] xPoints, int[] yPoints, int nPoints)` Overrides `Graphics.drawPolygon`.
`void`	`drawPolyline(int[] xPoints, int[] yPoints, int nPoints)` Overrides `Graphics.drawPolyline`.
`void`	`drawRect(int x, int y, int width, int height)` Overrides `Graphics.drawRect`.
`void`	`drawRoundRect(int x, int y, int width, int height, int arcWidth, int arcHeight)` Overrides `Graphics.drawRoundRect`.
`void`	`drawString(AttributedCharacterIterator iterator, int x, int y)` Overrides `Graphics.drawString`.
`void`	`drawString(String aString, int x, int y)` Overrides `Graphics.drawString`.
`void`	`fill3DRect(int x, int y, int width, int height, boolean raised)` Overrides `Graphics.fill3DRect`.
`void`	`fillArc(int x, int y, int width, int height, int startAngle, int arcAngle)` Overrides `Graphics.fillArc`.
`void`	`fillOval(int x, int y, int width, int height)` Overrides `Graphics.fillOval`.
`void`	`fillPolygon(int[] xPoints, int[] yPoints, int nPoints)` Overrides `Graphics.fillPolygon`.
`void`	`fillRect(int x, int y, int width, int height)` Overrides `Graphics.fillRect`.
`void`	`fillRoundRect(int x, int y, int width, int height, int arcWidth, int arcHeight)` Overrides `Graphics.fillRoundRect`.
`static Color`	`flashColor()` Returns the Color used to flash drawing operations.
`static int`	`flashCount()` Returns the number of times that drawing operations will flash.
`static int`	`flashTime()` Returns the time delay of drawing operation flashing.
`Shape`	`getClip()` Overrides `Graphics.getClip`.
`Rectangle`	`getClipBounds()` Overrides `Graphics.getClipBounds`.
`Color`	`getColor()` Returns the Color used for text drawing operations.
`int`	`getDebugOptions()` Returns the current debugging options for this DebugGraphics.
`Font`	`getFont()` Returns the Font used for text drawing operations.
`FontMetrics`	`getFontMetrics()` Overrides `Graphics.getFontMetrics`.
`FontMetrics`	`getFontMetrics(Font f)` Overrides `Graphics.getFontMetrics`.
`boolean`	`isDrawingBuffer()` Returns the drawingBuffer value.
`static PrintStream`	`logStream()` Returns the stream to which the DebugGraphics logs drawing operations.
`void`	`setClip(int x, int y, int width, int height)` Overrides `Graphics.setClip`.
`void`	`setClip(Shape clip)` Overrides `Graphics.setClip`.
`void`	`setColor(Color aColor)` Sets the color to be used for drawing and filling lines and shapes.
`void`	`setDebugOptions(int options)` Enables/disables diagnostic information about every graphics operation.
`static void`	`setFlashColor(Color flashColor)` Sets the Color used to flash drawing operations.
`static void`	`setFlashCount(int flashCount)` Sets the number of times that drawing operations will flash.
`static void`	`setFlashTime(int flashTime)` Sets the time delay of drawing operation flashing.
`void`	`setFont(Font aFont)` Sets the Font used for text drawing operations.
`static void`	`setLogStream(PrintStream stream)` Sets the stream to which the DebugGraphics logs drawing operations.
`void`	`setPaintMode()` Overrides `Graphics.setPaintMode`.
`void`	`setXORMode(Color aColor)` Overrides `Graphics.setXORMode`.
`void`	`translate(int x, int y)` Overrides `Graphics.translate`.

Methods inherited from class java.awt.Graphics
clearRect, clipRect, copyArea, create, create, dispose, draw3DRect, drawArc, drawBytes, drawChars, drawImage, drawImage, drawImage, drawImage, drawImage, drawImage, drawLine, drawOval, drawPolygon, drawPolygon, drawPolyline, drawRect, drawRoundRect, drawString, drawString, fill3DRect, fillArc, fillOval, fillPolygon, fillPolygon, fillRect, fillRoundRect, finalize, getClip, getClipBounds, getClipBounds, getClipRect, getColor, getFont, getFontMetrics, getFontMetrics, hitClip, setClip, setClip, setColor, setFont, setPaintMode, setXORMode, toString, translate

Methods inherited from class java.awt.Graphics


clearRect, clipRect, copyArea, create, create, dispose, draw3DRect, drawArc, drawBytes, drawChars, drawImage, drawImage, drawImage, drawImage, drawImage, drawImage, drawLine, drawOval, drawPolygon, drawPolygon, drawPolyline, drawRect, drawRoundRect, drawString, drawString, fill3DRect, fillArc, fillOval, fillPolygon, fillPolygon, fillRect, fillRoundRect, finalize, getClip, getClipBounds, getClipBounds, getClipRect, getColor, getFont, getFontMetrics, getFontMetrics, hitClip, setClip, setClip, setColor, setFont, setPaintMode, setXORMode, toString, translate

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

BUFFERED_OPTION

public static final int BUFFERED_OPTION

Show buffered operations in a separate Frame.

FLASH_OPTION

public static final int FLASH_OPTION

Flash graphics operations.

LOG_OPTION

public static final int LOG_OPTION

Log graphics operations.

NONE_OPTION

public static final int NONE_OPTION

Don't debug graphics operations.

Constructor Detail

DebugGraphics

public DebugGraphics()

Constructs a new debug graphics context that supports slowed down drawing.

DebugGraphics

public DebugGraphics(Graphics graphics)

Constructs a debug graphics context from an existing graphics context that supports slowed down drawing.

Parameters:: graphics - the Graphics context to slow down

DebugGraphics

public DebugGraphics(Graphics graphics,
                     JComponent component)

Constructs a debug graphics context from an existing graphics context that slows down drawing for the specified component.

Parameters:: graphics - the Graphics context to slow down; component - the JComponent to draw slowly

Method Detail

clearRect

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

Overrides Graphics.clearRect.

Overrides:: clearRect in class Graphics
Parameters:: x; y; width; height

clipRect

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

Overrides Graphics.clipRect.

Overrides:: clipRect in class Graphics
Parameters:: x; y; width; height

copyArea

public void copyArea(int x,
                     int y,
                     int width,
                     int height,
                     int destX,
                     int destY)

Overrides Graphics.copyArea.

Overrides:: copyArea in class Graphics
Parameters:: x; y; width; height; destX; destY

create

public Graphics create()

Overrides Graphics.create to return a DebugGraphics object.

Overrides:: create in class Graphics

create

public Graphics create(int x,
                       int y,
                       int width,
                       int height)

Overrides Graphics.create to return a DebugGraphics object.

Overrides:: create in class Graphics
Parameters:: x; y; width; height

dispose

public void dispose()

Overrides Graphics.dispose.

Overrides:: dispose in class Graphics

draw3DRect

public void draw3DRect(int x,
                       int y,
                       int width,
                       int height,
                       boolean raised)

Overrides Graphics.draw3DRect.

Overrides:: draw3DRect in class Graphics
Parameters:: x; y; width; height; raised

drawArc

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

Overrides Graphics.drawArc.

Overrides:: drawArc in class Graphics
Parameters:: x; y; width; height; startAngle; arcAngle

drawBytes

public void drawBytes(byte[] data,
                      int offset,
                      int length,
                      int x,
                      int y)

Overrides Graphics.drawBytes.

Overrides:: drawBytes in class Graphics
Parameters:: data; offset; length; x; y

drawChars

public void drawChars(char[] data,
                      int offset,
                      int length,
                      int x,
                      int y)

Overrides Graphics.drawChars.

Overrides:: drawChars in class Graphics
Parameters:: data; offset; length; x; y