oracle.jdeveloper.vcs.spi
Class VCSNodeOverlayTracker

java.lang.Object
  oracle.ide.explorer.IconOverlayTracker
      oracle.jdeveloper.vcs.spi.VCSNodeOverlayTracker

All Implemented Interfaces:

java.util.Observer, VCSEBComponent

public class VCSNodeOverlayTracker
extends IconOverlayTracker
implements java.util.Observer, VCSEBComponent

Class for a node overlay tracker based around a version control status cache. The implementation will ensure that overlays are refreshed when statuses become dirty. Expansion of registered composite file elements (the oracle.ide.composite API) is handled internally. Also, the tracker will automatically be associated and disassociated with navigator windows when they are created and closed.

Since:

10.1.3.0.1

Constructor Summary

VCSNodeOverlayTracker(int batchSize, VCSOverlayItemProducer overlayItemProducer, URLFilter filter, java.lang.String vcsId)

Method Summary

protected IconOverlay	getCompositeElementOverlay(java.net.URL[] urls)
protected IconOverlay[]	getOverlays(Element[] elements) Gets the displayable overlay information for the given elements.
void	handleMessage(VCSEBMessage message) Handles a message sent on the VCSEventBus.
protected boolean	isControlled(Element element) Asks whether the given element is controlled by the overlay client.
protected void	startTracking()
void	stopTracking() Performs cleanup after use and prior to finalization.
void	update(java.util.Observable o, java.lang.Object arg)

Methods inherited from class oracle.ide.explorer.IconOverlayTracker

getOverlayCache, getValidElements, repaintOverlays, validateOverlay, validateOverlays

Methods inherited from class java.lang.Object

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

Constructor Detail

VCSNodeOverlayTracker

public VCSNodeOverlayTracker(int batchSize,
                             VCSOverlayItemProducer overlayItemProducer,
                             URLFilter filter,
                             java.lang.String vcsId)

Method Detail

update

public void update(java.util.Observable o,
                   java.lang.Object arg)

Specified by:

update in interface java.util.Observer

handleMessage

public void handleMessage(VCSEBMessage message)

Description copied from interface: VCSEBComponent

Handles a message sent on the VCSEventBus.

Specified by:

handleMessage in interface VCSEBComponent

Parameters:

message - the message to handle.

startTracking

protected void startTracking()

Overrides:

startTracking in class IconOverlayTracker

stopTracking

public void stopTracking()

Description copied from class: IconOverlayTracker

Performs cleanup after use and prior to finalization.

Overrides:

stopTracking in class IconOverlayTracker

isControlled

protected boolean isControlled(Element element)

Description copied from class: IconOverlayTracker

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

Specified by:

isControlled in class IconOverlayTracker

Parameters:

element - the element.

Returns:

a verdict.

getOverlays

protected IconOverlay[] getOverlays(Element[] elements)

Description copied from class: IconOverlayTracker

Gets the displayable overlay information for the given elements.

Specified by:

getOverlays in class IconOverlayTracker

Parameters:

elements - the collection of elements.

Returns:

the collection of corresponding displayable overlay objects.

getCompositeElementOverlay

protected IconOverlay getCompositeElementOverlay(java.net.URL[] urls)
                                          throws java.lang.Exception

Throws:

java.lang.Exception