org.eclipse.gef4.mvc.models

Class SelectionModel<VR>

java.lang.Object

org.eclipse.gef4.mvc.models.SelectionModel<VR>

Type Parameters:

VR - The visual root node of the UI toolkit used, e.g. javafx.scene.Node in case of JavaFX.

All Implemented Interfaces:

IPropertyChangeNotifier

public class SelectionModel<VR>
extends java.lang.Object
implements IPropertyChangeNotifier

The SelectionModel is used to store the current viewer's IContentPart selection. A selection tool is used to update the SelectionModel as the result of input events.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SELECTION_PROPERTY "selection" The property name which is used for PropertyChangeEvents.

Constructor Summary

Constructors

Constructor and Description
SelectionModel()

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
void	appendSelection(java.util.List<? extends IContentPart<VR,? extends VR>> contentParts) Appends the given IContentParts to the current selection, i.e.
void	deselect(java.util.Collection<? extends IContentPart<VR,? extends VR>> contentParts) Removes the given IContentParts from the current selection.
void	deselectAll() Clears the current selection.
java.util.List<IContentPart<VR,? extends VR>>	getSelected() Returns an unmodifiable list of the currently selected IContentParts.
boolean	isSelected(IContentPart<VR,? extends VR> contentPart) Returns true if the given IContentPart is part of the current selection.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
void	select(java.util.List<? extends IContentPart<VR,? extends VR>> additionalSelected) Updates the current selection by adding the given list of IContentParts, preserving already selected elements.
void	updateSelection(java.util.List<? extends IContentPart<VR,? extends VR>> newSelection) Replaces the whole selection with the given list of IContentPart s.

Methods inherited from class java.lang.Object

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

Field Detail

SELECTION_PROPERTY

public static final java.lang.String SELECTION_PROPERTY

 "selection"
 

The property name which is used for PropertyChangeEvents.

See Also:

Constant Field Values

Constructor Detail

SelectionModel

public SelectionModel()

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

addPropertyChangeListener in interface IPropertyChangeNotifier

appendSelection

public void appendSelection(java.util.List<? extends IContentPart<VR,? extends VR>> contentParts)

Appends the given IContentParts to the current selection, i.e. inserts them at the end of the selection.

Parameters:

contentParts - The IContentParts which are appended to the selection.

deselect

public void deselect(java.util.Collection<? extends IContentPart<VR,? extends VR>> contentParts)

Removes the given IContentParts from the current selection.

Parameters:

contentParts - The IContentParts which are removed from the selection.

deselectAll

public void deselectAll()

Clears the current selection.

getSelected

public java.util.List<IContentPart<VR,? extends VR>> getSelected()

Returns an unmodifiable list of the currently selected IContentParts.

Returns:

An unmodifiable list of the currently selected IContentParts.

isSelected

public boolean isSelected(IContentPart<VR,? extends VR> contentPart)

Returns true if the given IContentPart is part of the current selection.

Parameters:

contentPart - The IContentPart which is checked for containment.

Returns:

true if the IContentPart is contained by the current selection.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

removePropertyChangeListener in interface IPropertyChangeNotifier

select

public void select(java.util.List<? extends IContentPart<VR,? extends VR>> additionalSelected)

Updates the current selection by adding the given list of IContentParts, preserving already selected elements. That is, if a member of the given list is not contained in the current selection, it will be added to it. If a member of the current selection is not contained in the given list, it will remain selected. The selection order will be adjusted, so that the given elements are in front.

Parameters:

additionalSelected - The IContentParts to add to/move within the current selection.

updateSelection

public void updateSelection(java.util.List<? extends IContentPart<VR,? extends VR>> newSelection)

Replaces the whole selection with the given list of IContentPart s.

Parameters:

newSelection - The list of IContentParts constituting the new selection.