oracle.ide.explorer
Class IconOverlayTracker

java.lang.Object
  oracle.ide.explorer.IconOverlayTracker

public abstract class IconOverlayTracker

extends java.lang.Object

Utility class for node overlay clients, tracking node visibility for an overlay cache.

Constructor Summary

IconOverlayTracker(java.lang.String infoTypeId, IconOverlayCache cache)
Constructor.

IconOverlayTracker(java.lang.String infoTypeId, IconOverlayCache cache, int batchSize)
Constructor.

Method Summary

IconOverlayCache	getOverlayCache() Gets the icon overlay cache for this overlay tracker instance.
protected abstract IconOverlay[]	getOverlays(Element[] elements) Gets the displayable overlay information for the given elements.
protected abstract boolean	isControlled(Element e) Asks whether the given element is controlled by the overlay client.
void	repaintOverlays() Repaints all visible consumer nodes after state changes.
void	stopTracking() Performs cleanup after use and prior to finalization.
void	validateOverlay(Element e) Validates the given element within the overlay cache.
void	validateOverlays() Validates all elements within the overlay cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

IconOverlayTracker

public IconOverlayTracker(java.lang.String infoTypeId,
                          IconOverlayCache cache)

Constructor.

Parameters:

infoTypeId - the unique identifier for the type of information this tracker tracks.

cache - the cache.

IconOverlayTracker

public IconOverlayTracker(java.lang.String infoTypeId,
                          IconOverlayCache cache,
                          int batchSize)

Constructor.

Parameters:

infoTypeId - the unique identifier for the type of information this tracker tracks.

cache - the cache.

batchSize - the overlay request batch size.

Method Detail

getOverlayCache

public IconOverlayCache getOverlayCache()

Gets the icon overlay cache for this overlay tracker instance.

Returns:

the IconOverlayCache of the tracker.

isControlled

protected abstract boolean isControlled(Element e)

Asks whether the given element is controlled by the overlay client.

Parameters:

e - the element.

Returns:

a verdict.

getOverlays

protected abstract IconOverlay[] getOverlays(Element[] elements)

Gets the displayable overlay information for the given elements.

Parameters:

elements - the collection of elements.

Returns:

the collection of corresponding displayable overlay objects.

validateOverlay

public void validateOverlay(Element e)

Validates the given element within the overlay cache.

Parameters:

e - the element.

validateOverlays

public void validateOverlays()

Validates all elements within the overlay cache.

repaintOverlays

public void repaintOverlays()

Repaints all visible consumer nodes after state changes.

stopTracking

public void stopTracking()

Performs cleanup after use and prior to finalization.