public class RepaintManager extends Object
This class manages repaint requests, allowing the number of repaints to be minimized, for example by collapsing multiple requests into a single repaint for members of a component tree.
As of 1.6 RepaintManager
handles repaint requests for Swing's top level components (JApplet
, JWindow
, JFrame
and JDialog
). Any calls to repaint
on one of these will call into the appropriate addDirtyRegion
method.
public RepaintManager()
Create a new RepaintManager instance. You rarely call this constructor. directly. To get the default RepaintManager, use RepaintManager.currentManager(JComponent) (normally "this").
public static RepaintManager currentManager(Component c)
Return the RepaintManager for the calling thread given a Component.
c
- a Component -- unused in the default implementation, but could be used by an overridden version to return a different RepaintManager depending on the Componentpublic static RepaintManager currentManager(JComponent c)
Return the RepaintManager for the calling thread given a JComponent.
Note: This method exists for backward binary compatibility with earlier versions of the Swing library. It simply returns the result returned by currentManager(Component)
.
c
- a JComponent -- unusedpublic static void setCurrentManager(RepaintManager aRepaintManager)
Set the RepaintManager that should be used for the calling thread. aRepaintManager will become the current RepaintManager for the calling thread's thread group.
aRepaintManager
- the RepaintManager object to usepublic void addInvalidComponent(JComponent invalidComponent)
Mark the component as in need of layout and queue a runnable for the event dispatching thread that will validate the components first isValidateRoot() ancestor.
public void removeInvalidComponent(JComponent component)
Remove a component from the list of invalid components.
public void addDirtyRegion(JComponent c, int x, int y, int w, int h)
Add a component in the list of components that should be refreshed. If c already has a dirty region, the rectangle (x,y,w,h) will be unioned with the region that should be redrawn.
c
- Component to repaint, null results in nothing happening.x
- X coordinate of the region to repainty
- Y coordinate of the region to repaintw
- Width of the region to repainth
- Height of the region to repaintJComponent.repaint(long, int, int, int, int)
public void addDirtyRegion(Window window, int x, int y, int w, int h)
Adds window
to the list of Component
s that need to be repainted.
window
- Window to repaint, null results in nothing happening.x
- X coordinate of the region to repainty
- Y coordinate of the region to repaintw
- Width of the region to repainth
- Height of the region to repaintJFrame.repaint(long, int, int, int, int)
, JWindow.repaint(long, int, int, int, int)
, JDialog.repaint(long, int, int, int, int)
public void addDirtyRegion(Applet applet, int x, int y, int w, int h)
Adds applet
to the list of Component
s that need to be repainted.
applet
- Applet to repaint, null results in nothing happening.x
- X coordinate of the region to repainty
- Y coordinate of the region to repaintw
- Width of the region to repainth
- Height of the region to repaintJApplet.repaint(long, int, int, int, int)
public Rectangle getDirtyRegion(JComponent aComponent)
Return the current dirty region for a component. Return an empty rectangle if the component is not dirty.
public void markCompletelyDirty(JComponent aComponent)
Mark a component completely dirty. aComponent will be completely painted during the next paintDirtyRegions() call.
public void markCompletelyClean(JComponent aComponent)
Mark a component completely clean. aComponent will not get painted during the next paintDirtyRegions() call.
public boolean isCompletelyDirty(JComponent aComponent)
Convenience method that returns true if aComponent will be completely painted during the next paintDirtyRegions(). If computing dirty regions is expensive for your component, use this method and avoid computing dirty region if it return true.
public void validateInvalidComponents()
Validate all of the components that have been marked invalid.
public void paintDirtyRegions()
Paint all of the components that have been marked dirty.
public String toString()
Returns a string that displays and identifies this object's properties.
public Image getOffscreenBuffer(Component c, int proposedWidth, int proposedHeight)
Return the offscreen buffer that should be used as a double buffer with the component c
. By default there is a double buffer per RepaintManager. The buffer might be smaller than (proposedWidth,proposedHeight)
This happens when the maximum double buffer size as been set for the receiving repaint manager.
public Image getVolatileOffscreenBuffer(Component c, int proposedWidth, int proposedHeight)
Return a volatile offscreen buffer that should be used as a double buffer with the specified component c
. The image returned will be an instance of VolatileImage, or null if a VolatileImage object could not be instantiated. This buffer might be smaller than (proposedWidth,proposedHeight)
. This happens when the maximum double buffer size has been set for this repaint manager.
VolatileImage
public void setDoubleBufferMaximumSize(Dimension d)
Set the maximum double buffer size.
public Dimension getDoubleBufferMaximumSize()
Returns the maximum double buffer size.
public void setDoubleBufferingEnabled(boolean aFlag)
Enables or disables double buffering in this RepaintManager. CAUTION: The default value for this property is set for optimal paint performance on the given platform and it is not recommended that programs modify this property directly.
aFlag
- true to activate double bufferingisDoubleBufferingEnabled()
public boolean isDoubleBufferingEnabled()
Returns true if this RepaintManager is double buffered. The default value for this property may vary from platform to platform. On platforms where native double buffering is supported in the AWT, the default value will be false
to avoid unnecessary buffering in Swing. On platforms where native double buffering is not supported, the default value will be true
.
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.