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 selection. It represents the selection as an ordered list of IContentParts. Thereby, it supports a multi-selection and allows to identify a primary selection (the head element of the list) that may be treated specially.

The SelectionModel is an IPropertyChangeNotifier and will notify about changes to the selection, using the SELECTION_PROPERTY property name.

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	appendToSelection(IContentPart<VR,? extends VR> toBeAppended) Updates the current selection by adding the given IContentPart to it, preserving already selected elements.
void	appendToSelection(java.util.List<? extends IContentPart<VR,? extends VR>> toBeAppended) Updates the current selection by adding the given IContentParts to it, preserving already selected elements.
void	clearSelection() Clears the current selection.
java.util.List<IContentPart<VR,? extends VR>>	getSelection() Returns an unmodifiable list of the currently selected IContentParts.
boolean	isSelected(IContentPart<VR,? extends VR> contentPart) Returns whether the given IContentPart is part of the current selection.
void	prependToSelection(IContentPart<VR,? extends VR> toBePrepended) Updates the current selection by adding the given IContentPart to it, preserving already selected elements.
void	prependToSelection(java.util.List<? extends IContentPart<VR,? extends VR>> toBePrepended) Updates the current selection by adding the given IContentParts to it, preserving already selected elements.
void	removeFromSelection(java.util.Collection<? extends IContentPart<VR,? extends VR>> contentParts) Removes the given IContentParts from the current selection if they are contained.
void	removeFromSelection(IContentPart<VR,? extends VR> contentPart) Removes the given IContentPart from the current selection if it is currently selected.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
void	setSelection(IContentPart<VR,? extends VR> newSelection) Replaces the current selection with the given IContentPart.
void	setSelection(java.util.List<? extends IContentPart<VR,? extends VR>> newSelection) Replaces the current 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

appendToSelection

public void appendToSelection(IContentPart<VR,? extends VR> toBeAppended)

Updates the current selection by adding the given IContentPart to it, preserving already selected elements.

If the given content part is not already selected, it will be added to the back of the given selection, otherwise it will be moved to the back. A member of the current selection that is not contained in the given list, will remain selected.

Parameters:

toBeAppended - The IContentPart to add to/move to the back of the current selection.

appendToSelection

public void appendToSelection(java.util.List<? extends IContentPart<VR,? extends VR>> toBeAppended)

Updates the current selection by adding the given IContentParts to it, preserving already selected elements.

A member of the given list that is not contained in the current selection, will be added to it. A member of the current selection that is not contained in the given list, will remain selected.

The selection order will be adjusted, so that the members of the given list are added at the back (in the order they are given), preceded by the already selected elements not contained in the given list (preserving their relative order).

Parameters:

toBeAppended - The IContentParts to add to/move to the back of the current selection.

clearSelection

public void clearSelection()

Clears the current selection.

getSelection

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

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 whether 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.

prependToSelection

public void prependToSelection(IContentPart<VR,? extends VR> toBePrepended)

Updates the current selection by adding the given IContentPart to it, preserving already selected elements.

If the given content part is not already selected, it will be added to the front of the given selection, otherwise it will be moved to the front. A member of the current selection that is not contained in the given list, will remain selected.

Parameters:

toBePrepended - The IContentPart to add to/move to the front of the current selection.

prependToSelection

public void prependToSelection(java.util.List<? extends IContentPart<VR,? extends VR>> toBePrepended)

Updates the current selection by adding the given IContentParts to it, preserving already selected elements.

A member of the given list that is not contained in the current selection, will be added to it. A member of the current selection that is not contained in the given list, will remain selected.

The selection order will be adjusted, so that the members of the given list are added in front (in the order they are given), followed by the already selected elements not contained in the given list (preserving their relative order).

Parameters:

toBePrepended - The IContentParts to add to/move to the front of the current selection.

removeFromSelection

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

Removes the given IContentParts from the current selection if they are contained. Ignores those that are not part of the current selection.

Parameters:

contentParts - The IContentParts which are removed from the selection.

removeFromSelection

public void removeFromSelection(IContentPart<VR,? extends VR> contentPart)

Removes the given IContentPart from the current selection if it is currently selected. Will not change the current selection otherwise.

Parameters:

contentPart - The IContentPart that is to be removed from the selection.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

removePropertyChangeListener in interface IPropertyChangeNotifier

setSelection

public void setSelection(IContentPart<VR,? extends VR> newSelection)

Replaces the current selection with the given IContentPart.

Parameters:

newSelection - The IContentPart constituting the new selection.

setSelection

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

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

Parameters:

newSelection - The list of IContentParts constituting the new selection.