Package org.eclipse.handly.ui.outline
Class ResourceChangeListenerContribution
java.lang.Object
org.eclipse.handly.ui.outline.OutlineContribution
org.eclipse.handly.ui.outline.ResourceChangeListenerContribution
- All Implemented Interfaces:
IOutlineContribution
- Direct Known Subclasses:
ProblemMarkerListenerContribution
An abstract base class for outline contributions listening to
IResourceChangeEvents.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract booleanReturns whether the given resource change event affects the outline's input element.voiddispose()Disposes of this contribution.voidinit(ICommonOutlinePage outlinePage) Initializes this contribution.protected abstract voidresourceChanged(org.eclipse.core.resources.IResourceChangeEvent event) Notifies that the outline page is affected in some way by the given resource change event.Methods inherited from class org.eclipse.handly.ui.outline.OutlineContribution
getOutlinePage
-
Constructor Details
-
ResourceChangeListenerContribution
public ResourceChangeListenerContribution()
-
-
Method Details
-
init
Initializes this contribution. This method is called after the outline page's tree viewer has been created.This method may be extended by subclasses. Subclasses must call the superclass implementation.
ResourceChangeListenerContributionextends this method to register a resource change listener that invokesresourceChanged(IResourceChangeEvent)if the resource change eventaffectsthe outline's input element.- Specified by:
initin interfaceIOutlineContribution- Overrides:
initin classOutlineContribution- Parameters:
outlinePage- the contribution's outline page (nevernull)
-
dispose
public void dispose()Description copied from class:OutlineContributionDisposes of this contribution. Implementors should clean up any resources associated with this contribution. Note that there is no guarantee thatinit()has been called. This method has no effect if this contribution has already been disposed.This method may be extended by subclasses. Subclasses must call the superclass implementation.
- Specified by:
disposein interfaceIOutlineContribution- Overrides:
disposein classOutlineContribution
-
affects
protected abstract boolean affects(org.eclipse.core.resources.IResourceChangeEvent event, Object inputElement) Returns whether the given resource change event affects the outline's input element.- Parameters:
event- nevernullinputElement- nevernull- Returns:
trueif the given resource change event affects the outline's input element, andfalseotherwise
-
resourceChanged
protected abstract void resourceChanged(org.eclipse.core.resources.IResourceChangeEvent event) Notifies that the outline page is affected in some way by the given resource change event.Note: This method may be called in any thread. The event object (and the delta within it) is valid only for the duration of the invocation of this method.
- Parameters:
event- nevernull
-