Package org.eclipse.gef.ui.parts
Class SelectionSynchronizer
java.lang.Object
org.eclipse.gef.ui.parts.SelectionSynchronizer
- All Implemented Interfaces:
ISelectionChangedListener
A utility for synchronizing the selection of multiple EditPartViewers. This
class performs selection synchronization by taking the selection from one
viewer, and mapping it to the selection in another viewer. The mapping is
performed by matching the models of the selected EditParts from one viewer to
the EditParts with the same models in another. It can be customized by
overriding the
convert(EditPartViewer, EditPart) method.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddViewer(EditPartViewer viewer) Adds a viewer to the set of synchronized viewersprotected voidapplySelection(EditPartViewer viewer, ISelection selection) Applies the given EditPart selection from another viewer to the given viewer.protected EditPartconvert(EditPartViewer viewer, EditPart part) Maps the given editpart from one viewer to an editpart in another viewer.voidremoveViewer(EditPartViewer viewer) Removes the viewer from the set of synchronized viewersvoidReceives notification from one viewer, and maps selection to all other members.voidsetEnabled(boolean value) Enables or disabled synchronization between viewers.protected voidsyncSelection(EditPartViewer selectionSource, ISelection selection) Synchronizes the given selection to all registered viewers except the one serving as selectionSource, by delegating toapplySelection(EditPartViewer, ISelection).
-
Constructor Details
-
SelectionSynchronizer
public SelectionSynchronizer()
-
-
Method Details
-
addViewer
Adds a viewer to the set of synchronized viewers- Parameters:
viewer- the viewer
-
convert
Maps the given editpart from one viewer to an editpart in another viewer. It returnsnullif there is no corresponding part. This method can be overridden to provide custom mapping.- Parameters:
viewer- the viewer being mapped topart- a part from another viewer- Returns:
nullor a corresponding editpart
-
removeViewer
Removes the viewer from the set of synchronized viewers- Parameters:
viewer- the viewer to remove
-
selectionChanged
Receives notification from one viewer, and maps selection to all other members.- Specified by:
selectionChangedin interfaceISelectionChangedListener- Parameters:
event- the selection event
-
syncSelection
Synchronizes the given selection to all registered viewers except the one serving as selectionSource, by delegating toapplySelection(EditPartViewer, ISelection).- Parameters:
selectionSource- The viewer from which the selection originated.selection- The selection to apply to the other viewers.- Since:
- 3.10
-
setEnabled
public void setEnabled(boolean value) Enables or disabled synchronization between viewers.- Parameters:
value-trueif synchronization should occur- Since:
- 3.1
-
applySelection
Applies the given EditPart selection from another viewer to the given viewer. It will first compute a new selection ofEditParts for the given viewer by searching those that control the same model elements as theEditParts in the given selection (viaconvert(EditPartViewer, EditPart)), apply this new selection to the given viewer, and reveal the last part in the new selection.- Parameters:
viewer- The viewer to apply the given selection to.selection- The selection to apply, which has to be anIStructuredSelectionofEditParts of another viewer.- Since:
- 3.10
-