org.eclipse.ui
Interface ISelectionService
-
All Known Subinterfaces:
-
IWorkbenchPage
-
public interface ISelectionService
A selection service tracks the selection within an object.
A listener that wants to be notified when the selection becomes
null must implement the INullSelectionListener
interface.
This service can be acquired from your service locator:
ISelectionService service = (ISelectionService) getSite().getService(ISelectionService.class);
- This service is not available globally, only from the workbench window level down.
-
See Also:
-
ISelectionListener,
INullSelectionListener,
IServiceLocator.getService(Class)
-
Restriction:
- This interface is not intended to be implemented by clients.
addSelectionListener
void addSelectionListener(
ISelectionListener listener)
- Adds the given selection listener.
Has no effect if an identical listener is already registered.
Note: listeners should be removed when no longer necessary. If
not, they will be removed when the IServiceLocator used to acquire this
service is disposed.
-
-
Parameters:
-
listener - a selection listener -
See Also:
-
removeSelectionListener(ISelectionListener)
addSelectionListener
void addSelectionListener(
String partId,
ISelectionListener listener)
- Adds a part-specific selection listener which is notified when selection changes
in the part with the given id. This is independent of part activation - the part
need not be active for notification to be sent.
When the part is created, the listener is passed the part's initial selection.
When the part is disposed, the listener is passed a null selection,
but only if the listener implements INullSelectionListener.
Note: This will not correctly track editor parts as each editor does
not have a unique partId.
Note: listeners should be removed when no longer necessary. If
not, they will be removed when the IServiceLocator used to acquire this
service is disposed.
-
-
Parameters:
-
partId - the id of the part to track -
listener - a selection listener -
Since:
- 2.0
-
See Also:
-
removeSelectionListener(String, ISelectionListener)
addPostSelectionListener
void addPostSelectionListener(
ISelectionListener listener)
- Adds the given post selection listener.It is equivalent to selection
changed if the selection was triggered by the mouse but it has a
delay if the selection is triggered by the keyboard arrows.
Has no effect if an identical listener is already registered.
Note: Works only for StructuredViewer(s).
Note: listeners should be removed when no longer necessary. If
not, they will be removed when the IServiceLocator used to acquire this
service is disposed.
-
-
Parameters:
-
listener - a selection listener -
See Also:
-
removePostSelectionListener(ISelectionListener)
addPostSelectionListener
void addPostSelectionListener(
String partId,
ISelectionListener listener)
- Adds a part-specific selection listener which is notified when selection changes
in the part with the given id. This is independent of part activation - the part
need not be active for notification to be sent.
When the part is created, the listener is passed the part's initial selection.
When the part is disposed, the listener is passed a null selection,
but only if the listener implements INullSelectionListener.
Note: This will not correctly track editor parts as each editor does
not have a unique partId.
Note: listeners should be removed when no longer necessary. If
not, they will be removed when the IServiceLocator used to acquire this
service is disposed.
-
-
Parameters:
-
partId - the id of the part to track -
listener - a selection listener -
Since:
- 2.0
-
See Also:
-
removePostSelectionListener(String, ISelectionListener)
getSelection
ISelection getSelection()
- Returns the current selection in the active part. If the selection in the
active part is undefined (the active part has no selection provider)
the result will be
null.
-
-
Returns:
- the current selection, or
null if undefined
getSelection
ISelection getSelection(
String partId)
- Returns the current selection in the part with the given id. If the part is not open,
or if the selection in the active part is undefined (the active part has no selection provider)
the result will be
null.
-
-
Parameters:
-
partId - the id of the part
-
Returns:
- the current selection, or
null if undefined -
Since:
- 2.0
removeSelectionListener
void removeSelectionListener(
ISelectionListener listener)
- Removes the given selection listener.
Has no effect if an identical listener is not registered.
-
-
Parameters:
-
listener - a selection listener
removeSelectionListener
void removeSelectionListener(
String partId,
ISelectionListener listener)
- Removes the given part-specific selection listener.
Has no effect if an identical listener is not registered for the given part id.
-
-
Parameters:
-
partId - the id of the part to track -
listener - a selection listener -
Since:
- 2.0
removePostSelectionListener
void removePostSelectionListener(
ISelectionListener listener)
- Removes the given post selection listener.
Has no effect if an identical listener is not registered.
-
-
Parameters:
-
listener - a selection listener
removePostSelectionListener
void removePostSelectionListener(
String partId,
ISelectionListener listener)
- Removes the given part-specific post selection listener.
Has no effect if an identical listener is not registered for the given part id.
-
-
Parameters:
-
partId - the id of the part to track -
listener - a selection listener -
Since:
- 2.0
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
