oracle.ide.explorer
Class IconOverlayTracker

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

Direct Known Subclasses:

VCSIconOverlayTracker

public abstract class IconOverlayTracker
extends java.lang.Object

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

Constructor Summary

IconOverlayTracker()

IconOverlayTracker(java.lang.String infoTypeId, IconOverlayCache cache)
Deprecated. replaced by declarative registration through icon-overlay-hook (derivative classes must implement a default constructor).

IconOverlayTracker(java.lang.String infoTypeId, IconOverlayCache cache, int batchSize)
Deprecated. replaced by declarative registration through icon-overlay-hook (derivative classes must implement a default constructor).

Method Summary

protected void	configure() Configures the IconOverlayTracker instance.
java.lang.String	getExtensionID()
java.lang.String	getInfoTypeID()
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 Element[]	getValidElements()
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.
protected void	startTracking() Deprecated. replaced by startTrackingImpl().
protected void	startTrackingImpl()
void	stopTracking() Deprecated. replaced by IconOverlayCoordinator.dispose() for callers and stopTrackingImpl() for overrides.
protected void	stopTrackingImpl()
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()

IconOverlayTracker

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

Deprecated. replaced by declarative registration through icon-overlay-hook (derivative classes must implement a default constructor).

Constructor.

Parameters:

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

cache - the cache.

IconOverlayTracker

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

Deprecated. replaced by declarative registration through icon-overlay-hook (derivative classes must implement a default constructor).

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.

configure

protected void configure()

Configures the IconOverlayTracker instance. Override this method to perform additional initialization after construction and configuration by the associated IconOverlayCoordinator.

getExtensionID

public final java.lang.String getExtensionID()

getInfoTypeID

public final java.lang.String getInfoTypeID()

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.

getValidElements

protected Element[] getValidElements()

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.

startTracking

@Deprecated
protected void startTracking()

Deprecated. replaced by startTrackingImpl().

stopTracking

@Deprecated
public void stopTracking()

Deprecated. replaced by IconOverlayCoordinator.dispose() for callers and stopTrackingImpl() for overrides.

Performs cleanup after use and prior to finalization.

startTrackingImpl

protected void startTrackingImpl()

stopTrackingImpl

protected void stopTrackingImpl()