javax.swing

Class 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
setDoubleBufferMaximumSize(Dimension size)
Set the value of the doubleBufferMaximumSize property.
void
setDoubleBufferingEnabled(boolean buffer)
Set the value of the doubleBufferingEnabled 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, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RepaintManager

public RepaintManager()
Create a new RepaintManager object.

Method Details

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

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

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

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

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

getDoubleBufferMaximumSize

public Dimension getDoubleBufferMaximumSize()
Get the value of the doubleBufferMaximumSize property.
Returns:
The current value of the property

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

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

isDoubleBufferingEnabled

public boolean isDoubleBufferingEnabled()
Get the value of the doubleBufferingEnabled property.
Returns:
The current value of the property

markCompletelyClean

public void markCompletelyClean(JComponent component)
Remove all dirty regions for a specified component
Parameters:
component - The component to mark as clean

markCompletelyDirty

public void markCompletelyDirty(JComponent component)
Mark a component as dirty over its entire bounds.
Parameters:
component - The component to mark as dirty

paintDirtyRegions

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

removeInvalidComponent

public void removeInvalidComponent(JComponent component)
Remove a component from the invalidComponents vector.
Parameters:
component - The component to remove

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

setDoubleBufferMaximumSize

public void setDoubleBufferMaximumSize(Dimension size)
Set the value of the doubleBufferMaximumSize property.
Parameters:
size - The new value of the property

setDoubleBufferingEnabled

public void setDoubleBufferingEnabled(boolean buffer)
Set the value of the doubleBufferingEnabled property.
Parameters:
buffer - The new value of the property

toString

public String toString()
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 interface Object
Returns:
the String representing this Object, which may be null

validateInvalidComponents

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

RepaintManager.java -- Copyright (C) 2002, 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.