|
Runtime | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IElementSelectionProvider
Interface describing a element selection provider for the element selection service.
Method Summary | |
---|---|
ElementSelectionServiceJob |
getMatchingObjects(IElementSelectionInput input,
IElementSelectionListener listener)
Retrieve a list of matching objects from the provider. |
java.lang.Object |
resolve(IMatchingObject object)
Resolve the matching object to a modeling object. |
void |
run(IProgressMonitor monitor)
Retrieve the list of matching objects from the provider. |
Methods inherited from interface org.eclipse.gmf.runtime.common.core.service.IProvider |
---|
addProviderChangeListener, provides, removeProviderChangeListener |
Method Detail |
---|
ElementSelectionServiceJob getMatchingObjects(IElementSelectionInput input, IElementSelectionListener listener)
The provider is given an IElementSelectionInput and IElementSelectionListener and creates a ElementSelectionServiceJob.
The provider returns IMatchingObjectEvent to the IElementSelectionListener. If there are ten matching objects, then eleven IMatchingObjectEvent will be sent to the listener. The first ten will have type MatchingObjectEventType.MATCH and will have a matching object. The eleventh event will have type MatchingObjectEventType.END_OF_MATCHES.
input
- the element selection input.listener
- the provider will send matching object events to this
listener.
void run(IProgressMonitor monitor)
The ElementSelectionServiceJob will invoke run. Clients must not call this method.
monitor
- a progress monitor in which the provider is running.java.lang.Object resolve(IMatchingObject object)
object
- the matching object.
|
Runtime | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp., Borland Software Corp., and others 2005,2006. All rights reserved.