ilog.views.util.swing

Class IlvExpensiveDrawingRepaintManager

java.lang.Object

javax.swing.RepaintManager

ilog.views.util.swing.IlvAbstractRepaintManager

ilog.views.util.swing.IlvExpensiveDrawingRepaintManager

public class IlvExpensiveDrawingRepaintManager
extends IlvAbstractRepaintManager

A repaint manager optimized for expensive drawing.

The default javax.swing.RepaintManager combines any two dirty rectangles that apply to the same Component into a single rectangle.

This class is more careful to minimize the area to be redrawn: It combines two dirty rectangles only sometimes. For example, it does not combine two small rectangles far apart on the screen.

This class is useful when you have a view which takes some time to redraw itself, due to complex or detailed drawing.

The constructor takes a few parameters that you can use to tune the performance of repainting. The optimal parameters will usually depend on the structure of the view.

An instance of this class can be installed through RepaintManager.setCurrentManager(javax.swing.RepaintManager).

Since:

JViews 8.1

Constructor Summary

Constructors

Constructor and Description
IlvExpensiveDrawingRepaintManager() Creates a repaint manager with default parameters.
IlvExpensiveDrawingRepaintManager(double combineAreaRatioThreshold, int combineAreaPixelsThreshold, boolean combineVertically, boolean combineHorizontally) Creates a repaint manager with given parameters.

Method Summary

Modifier and Type	Method and Description
protected void	addRectangle(LinkedList<Rectangle> list, int x, int y, int w, int h) Adds a rectangle to a region, represented as a list of rectangles.
protected JComponent	getDirtyComponentParent(JComponent comp) Returns the parent component of the given Swing component, or null when repainting shall be performed with the given Swing component directly.
protected boolean	isTopLevelComponent(Component comp) Returns true if the given component is considered a top-level component.
protected void	paintDirtyComponent(JComponent comp, Rectangle rect) Paints the designated region, part of the given Swing component, in the current thread.

Methods inherited from class ilog.views.util.swing.IlvAbstractRepaintManager

addDirtyRegion, addInvalidComponent, getDirtyRegion, isCompletelyDirty, markCompletelyClean, paintDirtyRegions, removeInvalidComponent, validateInvalidComponents

Methods inherited from class javax.swing.RepaintManager

addDirtyRegion, addDirtyRegion, currentManager, currentManager, getDoubleBufferMaximumSize, getOffscreenBuffer, getVolatileOffscreenBuffer, isDoubleBufferingEnabled, markCompletelyDirty, setCurrentManager, setDoubleBufferingEnabled, setDoubleBufferMaximumSize, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvExpensiveDrawingRepaintManager

public IlvExpensiveDrawingRepaintManager()

Creates a repaint manager with default parameters.

IlvExpensiveDrawingRepaintManager

public IlvExpensiveDrawingRepaintManager(double combineAreaRatioThreshold,
                                         int combineAreaPixelsThreshold,
                                         boolean combineVertically,
                                         boolean combineHorizontally)

Creates a repaint manager with given parameters.

Parameters:

combineAreaRatioThreshold - When merging two dirty rectangles into a single one, this variable limits the increase of the area of the rectangles: The merge will only be performed if the new rectangle's area is at most the sum of the two rectangles to be merged. multiplied with The default value is 2.0. combineAreaRatioThreshold.

combineAreaPixelsThreshold - When merging two dirty rectangles into a single one, this variable limits the increase of the area of the rectangles: The merge will only be performed if the new rectangle's area is at most the sum of the two rectangles to be merged, plus combineAreaPixelsThreshold. The default value is 10000, standing for a 100x100 pixels square.

combineVertically - If this flag is true, rectangles whose x ranges overlap will be merged. This is useful if the view contains mostly vertical objects, and if drawing such an object entirely is faster than drawing two pieces of it. The default value is faslse.

combineHorizontally - If this flag is true, rectangles whose y ranges overlap will be merged. This is useful if the view contains mostly horizontal objects, and if drawing such an object entirely is faster than drawing two pieces of it. The default value is faslse.

Method Detail

addRectangle

protected void addRectangle(LinkedList<Rectangle> list,
                            int x,
                            int y,
                            int w,
                            int h)

Adds a rectangle to a region, represented as a list of rectangles.

Overrides:

addRectangle in class IlvAbstractRepaintManager

Parameters:

list - A list of rectangles, each having a width > 0 and a height > 0

x - The x coordinate of the top left point of the additional rectangle.

y - the y coordinate of the top left point of the additional rectangle.

w - The width of the additional rectangle. Must be > 0.

h - The height of the additional rectangle. Must be > 0.

isTopLevelComponent

protected boolean isTopLevelComponent(Component comp)

Returns true if the given component is considered a top-level component. In this implementation, this is the case for instances of java.awt.Window and java.applet.Applet.

Overrides:

isTopLevelComponent in class IlvAbstractRepaintManager

Parameters:

comp - The component to check.

Returns:

True if the specified component an instance of java.awt.Window or java.awt.Applet, false otherwise.

getDirtyComponentParent

protected JComponent getDirtyComponentParent(JComponent comp)

Returns the parent component of the given Swing component, or null when repainting shall be performed with the given Swing component directly.

Overrides:

getDirtyComponentParent in class IlvAbstractRepaintManager

Parameters:

comp - The component of the parent to check.

Returns:

True if the parenent component of comp is an instance of JComponent, null otherwise.

paintDirtyComponent

protected void paintDirtyComponent(JComponent comp,
                                   Rectangle rect)

Paints the designated region, part of the given Swing component, in the current thread.

Overrides:

paintDirtyComponent in class IlvAbstractRepaintManager

Parameters:

comp - A Swing component.

rect - A rectangle, in coordinates relative to comp.