javax.swing
Class RepaintManager

java.lang.Object
  extended by javax.swing.RepaintManager

public class RepaintManager
extends Object

The repaint manager holds a set of dirty regions, invalid components, and a double buffer surface. The dirty regions and invalid components are used to coalesce multiple revalidate() and repaint() calls in the component tree into larger groups to be refreshed "all at once"; the double buffer surface is used by root components to paint themselves.

See this document for more details.

document for more details.


Constructor Summary
RepaintManager()
          Create a new RepaintManager object.
 
Method Summary
 void addDirtyRegion(JComponent component, int x, int y, int w, int h)
          Add a region to the set of dirty regions for a specified component.
 void addInvalidComponent(JComponent component)
          Add a component to the invalidComponents vector.
static RepaintManager currentManager(Component component)
          Returns the RepaintManager for the current thread's thread group.
static RepaintManager currentManager(JComponent component)
          Returns the RepaintManager for the current thread's thread group.
 Rectangle getDirtyRegion(JComponent component)
          Get the dirty region associated with a component, or null if the component has no dirty region.
 Dimension getDoubleBufferMaximumSize()
          Get the value of the doubleBufferMaximumSize property.
 Image getOffscreenBuffer(Component component, int proposedWidth, int proposedHeight)
          Get an offscreen buffer for painting a component's image.
 Image getVolatileOffscreenBuffer(Component comp, int proposedWidth, int proposedHeight)
          Creates and returns a volatile offscreen buffer for the specified component that can be used as a double buffer.
 boolean isCompletelyDirty(JComponent component)
          Return true if the specified component is completely contained within its dirty region, otherwise false
 boolean isDoubleBufferingEnabled()
          Get the value of the doubleBufferingEnabled property.
 void markCompletelyClean(JComponent component)
          Remove all dirty regions for a specified component
 void markCompletelyDirty(JComponent component)
          Mark a component as dirty over its entire bounds.
 void paintDirtyRegions()
          Repaint all regions of all components which have been marked dirty in the dirtyComponents table.
 void removeInvalidComponent(JComponent component)
          Remove a component from the invalidComponents vector.
static void setCurrentManager(RepaintManager manager)
          Sets the repaint manager for the calling thread's thread group.
 void setDoubleBufferingEnabled(boolean buffer)
          Set the value of the doubleBufferingEnabled property.
 void setDoubleBufferMaximumSize(Dimension size)
          Set the value of the doubleBufferMaximumSize property.
 String toString()
          Convert this Object to a human-readable String.
 void validateInvalidComponents()
          Validate all components which have been marked invalid in the invalidComponents vector.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RepaintManager

public RepaintManager()
Create a new RepaintManager object.

Method Detail

currentManager

public static RepaintManager currentManager(Component component)
Returns the RepaintManager for the current thread's thread group. The default implementation ignores the component parameter and returns the same repaint manager for all components.

Parameters:
component - a component to look up the manager of
Returns:
the current repaint manager for the calling thread's thread group and the specified component
See Also:
setCurrentManager(javax.swing.RepaintManager)

currentManager

public static RepaintManager currentManager(JComponent component)
Returns the RepaintManager for the current thread's thread group. The default implementation ignores the component parameter and returns the same repaint manager for all components. This method is only here for backwards compatibility with older versions of Swing and simply forwards to currentManager(Component).

Parameters:
component - a component to look up the manager of
Returns:
the current repaint manager for the calling thread's thread group and the specified component
See Also:
setCurrentManager(javax.swing.RepaintManager)

setCurrentManager

public static void setCurrentManager(RepaintManager manager)
Sets the repaint manager for the calling thread's thread group.

Parameters:
manager - the repaint manager to set for the current thread's thread group
See Also:
currentManager(Component)

addInvalidComponent

public void addInvalidComponent(JComponent component)
Add a component to the invalidComponents vector. If the repaintWorker class is not active, insert it in the system event queue.

Parameters:
component - The component to add
See Also:
removeInvalidComponent(javax.swing.JComponent)

removeInvalidComponent

public void removeInvalidComponent(JComponent component)
Remove a component from the invalidComponents vector.

Parameters:
component - The component to remove
See Also:
addInvalidComponent(javax.swing.JComponent)

addDirtyRegion

public void addDirtyRegion(JComponent component,
                           int x,
                           int y,
                           int w,
                           int h)
Add a region to the set of dirty regions for a specified component. This involves union'ing the new region with any existing dirty region associated with the component. If the repaintWorker class is not active, insert it in the system event queue.

Parameters:
component - The component to add a dirty region for
x - The left x coordinate of the new dirty region
y - The top y coordinate of the new dirty region
w - The width of the new dirty region
h - The height of the new dirty region
See Also:
addDirtyRegion(javax.swing.JComponent, int, int, int, int), getDirtyRegion(javax.swing.JComponent), isCompletelyDirty(javax.swing.JComponent), markCompletelyClean(javax.swing.JComponent), markCompletelyDirty(javax.swing.JComponent)

getDirtyRegion

public Rectangle getDirtyRegion(JComponent component)
Get the dirty region associated with a component, or null if the component has no dirty region.

Parameters:
component - The component to get the dirty region of
Returns:
The dirty region of the component
See Also:
dirtyComponents, addDirtyRegion(javax.swing.JComponent, int, int, int, int), isCompletelyDirty(javax.swing.JComponent), markCompletelyClean(javax.swing.JComponent), markCompletelyDirty(javax.swing.JComponent)

markCompletelyDirty

public void markCompletelyDirty(JComponent component)
Mark a component as dirty over its entire bounds.

Parameters:
component - The component to mark as dirty
See Also:
dirtyComponents, addDirtyRegion(javax.swing.JComponent, int, int, int, int), getDirtyRegion(javax.swing.JComponent), isCompletelyDirty(javax.swing.JComponent), markCompletelyClean(javax.swing.JComponent)

markCompletelyClean

public void markCompletelyClean(JComponent component)
Remove all dirty regions for a specified component

Parameters:
component - The component to mark as clean
See Also:
dirtyComponents, addDirtyRegion(javax.swing.JComponent, int, int, int, int), getDirtyRegion(javax.swing.JComponent), isCompletelyDirty(javax.swing.JComponent), markCompletelyDirty(javax.swing.JComponent)

isCompletelyDirty

public boolean isCompletelyDirty(JComponent component)
Return true if the specified component is completely contained within its dirty region, otherwise false

Parameters:
component - The component to check for complete dirtyness
Returns:
Whether the component is completely dirty
See Also:
dirtyComponents, addDirtyRegion(javax.swing.JComponent, int, int, int, int), getDirtyRegion(javax.swing.JComponent), isCompletelyDirty(javax.swing.JComponent), markCompletelyClean(javax.swing.JComponent)

validateInvalidComponents

public void validateInvalidComponents()
Validate all components which have been marked invalid in the invalidComponents vector.


paintDirtyRegions

public void paintDirtyRegions()
Repaint all regions of all components which have been marked dirty in the dirtyComponents table.


getOffscreenBuffer

public Image getOffscreenBuffer(Component component,
                                int proposedWidth,
                                int proposedHeight)
Get an offscreen buffer for painting a component's image. This image may be smaller than the proposed dimensions, depending on the value of the doubleBufferMaximumSize property.

Parameters:
component - The component to return an offscreen buffer for
proposedWidth - The proposed width of the offscreen buffer
proposedHeight - The proposed height of the offscreen buffer
Returns:
A shared offscreen buffer for painting

getVolatileOffscreenBuffer

public Image getVolatileOffscreenBuffer(Component comp,
                                        int proposedWidth,
                                        int proposedHeight)
Creates and returns a volatile offscreen buffer for the specified component that can be used as a double buffer. The returned image is a VolatileImage. Its size will be (proposedWidth, proposedHeight) except when the maximum double buffer size has been set in this RepaintManager.

Parameters:
comp - the Component for which to create a volatile buffer
proposedWidth - the proposed width of the buffer
proposedHeight - the proposed height of the buffer
Since:
1.4
See Also:
VolatileImage

getDoubleBufferMaximumSize

public Dimension getDoubleBufferMaximumSize()
Get the value of the doubleBufferMaximumSize property.

Returns:
The current value of the property
See Also:
setDoubleBufferMaximumSize(java.awt.Dimension)

setDoubleBufferMaximumSize

public void setDoubleBufferMaximumSize(Dimension size)
Set the value of the doubleBufferMaximumSize property.

Parameters:
size - The new value of the property
See Also:
getDoubleBufferMaximumSize()

setDoubleBufferingEnabled

public void setDoubleBufferingEnabled(boolean buffer)
Set the value of the doubleBufferingEnabled property.

Parameters:
buffer - The new value of the property
See Also:
isDoubleBufferingEnabled()

isDoubleBufferingEnabled

public boolean isDoubleBufferingEnabled()
Get the value of the doubleBufferingEnabled property.

Returns:
The current value of the property
See Also:
setDoubleBufferingEnabled(boolean)

toString

public String toString()
Description copied from class: Object
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() and such.

It is typical, but not required, to ensure that this method never completes abruptly with a RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

Overrides:
toString in class Object
Returns:
the String representing this Object, which may be null
See Also:
Object.getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)