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

Since:
1.2
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    BUFFERED_OPTION
    Show buffered operations in a separate Frame.
    static final int
    FLASH_OPTION
    Flash graphics operations.
    static final int
    LOG_OPTION
    Log graphics operations.
    static final int
    NONE_OPTION
    Don't debug graphics operations.

  • Constructor Summary

    Constructors
    Constructor
    Description
    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

    Modifier and Type
    Method
    Description
    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 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.
    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 x, int y, Color bgcolor, ImageObserver observer)
    Overrides Graphics.drawImage.
    boolean
    drawImage(Image img, int x, int y, 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(String aString, int x, int y)
    Overrides Graphics.drawString.
    void
    drawString(AttributedCharacterIterator iterator, 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 declared in class java.awt.Graphics

    drawPolygon, fillPolygon, finalize, getClipBounds, getClipRect, hitClip, toString

    Methods declared in class java.lang.Object

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

  • Field Details

    • LOG_OPTION

      public static final int LOG_OPTION
      Log graphics operations.
      See Also:

    • FLASH_OPTION

      public static final int FLASH_OPTION
      Flash graphics operations.
      See Also:

    • BUFFERED_OPTION

      public static final int BUFFERED_OPTION
      Show buffered operations in a separate Frame.
      See Also:

    • NONE_OPTION

      public static final int NONE_OPTION
      Don't debug graphics operations.
      See Also:

  • Constructor Details

    • DebugGraphics

      public DebugGraphics()
      Constructs a new debug graphics context that supports slowed down drawing.

      NOTE: This constructor should not be called by applications, it is for internal use only. When called directly it will create an un-usable instance.

    • 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

    • 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

  • Method Details

    • create

      public Graphics create()
      Overrides Graphics.create to return a DebugGraphics object.
      Specified by:
      create in class Graphics
      Returns:
      a new graphics context that is a copy of this graphics context.

    • 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 - 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:

    • setFlashColor

      public static void setFlashColor(Color flashColor)
      Sets the Color used to flash drawing operations.
      Parameters:
      flashColor - the Color used to flash drawing operations

    • flashColor

      public static Color flashColor()
      Returns the Color used to flash drawing operations.
      Returns:
      the Color used to flash drawing operations
      See Also:

    • setFlashTime

      public static void setFlashTime(int flashTime)
      Sets the time delay of drawing operation flashing.
      Parameters:
      flashTime - the time delay of drawing operation flashing

    • flashTime

      public static int flashTime()
      Returns the time delay of drawing operation flashing.
      Returns:
      the time delay of drawing operation flashing
      See Also:

    • setFlashCount

      public static void setFlashCount(int flashCount)
      Sets the number of times that drawing operations will flash.
      Parameters:
      flashCount - number of times that drawing operations will flash

    • flashCount

      public static int flashCount()
      Returns the number of times that drawing operations will flash.
      Returns:
      the number of times that drawing operations will flash
      See Also:

    • setLogStream

      public static void setLogStream(PrintStream stream)
      Sets the stream to which the DebugGraphics logs drawing operations.
      Parameters:
      stream - the stream to which the DebugGraphics logs drawing operations

    • logStream

      public static PrintStream logStream()
      Returns the stream to which the DebugGraphics logs drawing operations.
      Returns:
      the stream to which the DebugGraphics logs drawing operations
      See Also:

    • setFont

      public void setFont(Font aFont)
      Sets the Font used for text drawing operations.
      Specified by:
      setFont in class Graphics
      Parameters:
      aFont - the font.
      See Also:

    • getFont

      public Font getFont()
      Returns the Font used for text drawing operations.
      Specified by:
      getFont in class Graphics
      Returns:
      this graphics context's current font.
      See Also:

    • setColor

      public void setColor(Color aColor)
      Sets the color to be used for drawing and filling lines and shapes.
      Specified by:
      setColor in class Graphics
      Parameters:
      aColor - the new rendering color.
      See Also:

    • getColor

      public Color getColor()
      Returns the Color used for text drawing operations.
      Specified by:
      getColor in class Graphics
      Returns:
      this graphics context's current color.
      See Also:

    • getFontMetrics

      public FontMetrics getFontMetrics()
      Overrides Graphics.getFontMetrics.
      Overrides:
      getFontMetrics in class Graphics
      Returns:
      the font metrics of this graphics context's current font.
      See Also:

    • getFontMetrics

      public FontMetrics getFontMetrics(Font f)
      Overrides Graphics.getFontMetrics.
      Specified by:
      getFontMetrics in class Graphics
      Parameters:
      f - the specified font
      Returns:
      the font metrics for the specified font.
      See Also:

    • translate

      public void translate(int x, int y)
      Overrides Graphics.translate.
      Specified by:
      translate in class Graphics
      Parameters:
      x - the x coordinate.
      y - the y coordinate.

    • setPaintMode

      public void setPaintMode()
      Overrides Graphics.setPaintMode.
      Specified by:
      setPaintMode in class Graphics

    • setXORMode

      public void setXORMode(Color aColor)
      Overrides Graphics.setXORMode.
      Specified by:
      setXORMode in class Graphics
      Parameters:
      aColor - the XOR alternation color

    • getClipBounds

      public Rectangle getClipBounds()
      Overrides Graphics.getClipBounds.
      Specified by:
      getClipBounds in class Graphics
      Returns:
      the bounding rectangle of the current clipping area, or null if no clip is set.
      See Also:

    • clipRect

      public void clipRect(int x, int y, int width, int height)
      Overrides Graphics.clipRect.
      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

      public void setClip(int x, int y, int width, int height)
      Overrides Graphics.setClip.
      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.
      See Also:

    • getClip

      public Shape getClip()
      Overrides Graphics.getClip.
      Specified by:
      getClip in class Graphics
      Returns:
      a Shape object representing the current clipping area, or null if no clip is set.
      See Also:

    • setClip

      public void setClip(Shape clip)
      Overrides Graphics.setClip.
      Specified by:
      setClip in class Graphics
      Parameters:
      clip - the Shape to use to set the clip. Passing null clears the current clip.
      See Also:

    • drawRect

      public void drawRect(int x, int y, int width, int height)
      Overrides Graphics.drawRect.
      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:

    • fillRect

      public void fillRect(int x, int y, int width, int height)
      Overrides Graphics.fillRect.
      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:

    • clearRect

      public void clearRect(int x, int y, int width, int height)
      Overrides Graphics.clearRect.
      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:

    • drawRoundRect

      public void drawRoundRect(int x, int y, int width, int height, int arcWidth, int arcHeight)
      Overrides Graphics.drawRoundRect.
      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:

    • fillRoundRect

      public void fillRoundRect(int x, int y, int width, int height, int arcWidth, int arcHeight)
      Overrides Graphics.fillRoundRect.
      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:

    • drawLine

      public void drawLine(int x1, int y1, int x2, int y2)
      Overrides Graphics.drawLine.
      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.

    • draw3DRect

      public void draw3DRect(int x, int y, int width, int height, boolean raised)
      Overrides Graphics.draw3DRect.
      Overrides:
      draw3DRect 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.
      raised - a boolean that determines whether the rectangle appears to be raised above the surface or sunk into the surface.
      See Also: