oracle.jdeveloper.vcs.spi

Class VCSIconOverlayTracker

java.lang.Object

oracle.ide.explorer.IconOverlayTracker

oracle.jdeveloper.vcs.spi.VCSIconOverlayTracker

All Implemented Interfaces:

java.util.Observer, VCSEBComponent

Direct Known Subclasses:

VCSNodeOverlayTracker

public class VCSIconOverlayTracker
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:

11.1.2.0.0 (Sherman)

Constructor Summary

Constructors

Modifier	Constructor and Description
	VCSIconOverlayTracker()
protected	VCSIconOverlayTracker(int batchSize, VCSOverlayItemProducer overlayItemProducer, URLFilter filter, java.lang.String vcsId) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	configure() Configures the IconOverlayTracker instance.
static java.lang.String	createInfoTypeID(java.lang.String vcsId)
protected IconOverlay	getCompositeElementOverlay(java.net.URL[] urls)
VCSOverlayItemProducer	getOverlayItemProducer()
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.
void	setOverlayItemProducer(VCSOverlayItemProducer overlayItemProducer)
void	setSystemId(java.lang.String vcsId)
void	setURLFilter(URLFilter filter)
protected void	startTrackingImpl()
protected void	stopTrackingImpl()
void	update(java.util.Observable o, java.lang.Object arg)

Methods inherited from class oracle.ide.explorer.IconOverlayTracker

getExtensionID, getInfoTypeID, getOverlayCache, getValidElements, repaintOverlays, startTracking, stopTracking, validateOverlay, validateOverlays

Methods inherited from class java.lang.Object

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

Constructor Detail

VCSIconOverlayTracker

public VCSIconOverlayTracker()

VCSIconOverlayTracker

@Deprecated
protected VCSIconOverlayTracker(int batchSize,
                                VCSOverlayItemProducer overlayItemProducer,
                                URLFilter filter,
                                java.lang.String vcsId)

Deprecated.

Method Detail

createInfoTypeID

public static final java.lang.String createInfoTypeID(java.lang.String vcsId)

configure

protected void configure()

Description copied from class: IconOverlayTracker

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

Overrides:

configure in class IconOverlayTracker

setOverlayItemProducer

public final void setOverlayItemProducer(VCSOverlayItemProducer overlayItemProducer)

setURLFilter

public final void setURLFilter(URLFilter filter)

setSystemId

public final void setSystemId(java.lang.String vcsId)

getOverlayItemProducer

public final VCSOverlayItemProducer getOverlayItemProducer()

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.

startTrackingImpl

protected void startTrackingImpl()

Overrides:

startTrackingImpl in class IconOverlayTracker

stopTrackingImpl

protected void stopTrackingImpl()

Overrides:

stopTrackingImpl 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