com.yworks.yfiles.view

Class SelectionIndicatorManager<T extends ILookup>

java.lang.Object

com.yworks.yfiles.view.ModelManager<T>

com.yworks.yfiles.view.SelectionIndicatorManager<T>

Type Parameters:

T - The type of the items in the collection and selection model.

public class SelectionIndicatorManager<T extends ILookup>
extends ModelManager<T>

A ModelManager implementation that manages the visual decorations of selected elements in a canvas.

For each item in the Model that is marked as selected by the SelectionModel this class uses the ILookup mechanism of the items to lookup an ISelectionIndicatorInstaller implementation which will do the actual installation of the decoration in the canvas.

Constructor Summary

Constructors

Constructor and Description
SelectionIndicatorManager(CanvasControl canvas, IObservableCollection<T> model, ISelectionModel<T> selectionModel) Creates an instance that for all selected items in the model dynamically installs a selection render decoration.

Method Summary

Modifier and Type	Method and Description
ICanvasObject	addSelection(T item) Adds an item to the current selection.
protected ICanvasObjectGroup	getCanvasObjectGroup(T item) Callback used by ModelManager.install(Object) to retrieve the installer for a given item.
protected ICanvasObjectInstaller	getInstaller(T item) Callback used by ModelManager.install(Object) to retrieve the installer for a given item.
IObservableCollection<T>	getModel() Gets the model that describes the domain for the selection.
ISelectionModel<T>	getSelectionModel() Gets the selection model that determines which items are selected.
protected void	onDisabled() Called when this mode gets disabled.
protected void	onEnabled() Called when this mode gets enabled.
void	removeSelection(T item) Removes an item from the current selection.
void	setModel(IObservableCollection<T> value) Sets the model that describes the domain for the selection.
void	setSelectionModel(ISelectionModel<T> value) Sets the selection model that determines which items are selected.

Methods inherited from class com.yworks.yfiles.view.ModelManager

add, getCanvas, install, isEnabled, remove, setEnabled, unInstall

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectionIndicatorManager

public SelectionIndicatorManager(CanvasControl canvas,
                                 IObservableCollection<T> model,
                                 ISelectionModel<T> selectionModel)

Creates an instance that for all selected items in the model dynamically installs a selection render decoration.

Parameters:

canvas - The canvas to add the selection marks to.

model - The model that holds the domain.

selectionModel - The model that determines which items are selected.

Method Detail

addSelection

public ICanvasObject addSelection(T item)

Adds an item to the current selection.

Parameters:

item - The item whose selection decorator will added.

getCanvasObjectGroup

protected ICanvasObjectGroup getCanvasObjectGroup(T item)

Callback used by ModelManager.install(Object) to retrieve the installer for a given item.

This implementation always returns the SelectionGroup of the Canvas of this instance.

Specified by:

getCanvasObjectGroup in class ModelManager<T extends ILookup>

Parameters:

item - The item to find a canvas object group for.

Returns:

An ICanvasObjectGroup or null

getInstaller

protected ICanvasObjectInstaller getInstaller(T item)

Callback used by ModelManager.install(Object) to retrieve the installer for a given item.

This implementation uses the ILookup.lookup(java.lang.Class) of the item to retrieve an ISelectionIndicatorInstaller instance.

Specified by:

getInstaller in class ModelManager<T extends ILookup>

Parameters:

item - The item to find an installer for.

Returns:

An installer or null

getModel

public final IObservableCollection<T> getModel()

Gets the model that describes the domain for the selection.

Only item contained in this model can be rendered as selected.

Returns:

The Model.

See Also:

setModel(IObservableCollection)

getSelectionModel

public final ISelectionModel<T> getSelectionModel()

Gets the selection model that determines which items are selected.

May be null, in which case no elements are considered selected.

Returns:

The SelectionModel.

See Also:

setSelectionModel(ISelectionModel)

onDisabled

protected void onDisabled()

Description copied from class: ModelManager

Called when this mode gets disabled.

Specified by:

onDisabled in class ModelManager<T extends ILookup>

onEnabled

protected void onEnabled()

Description copied from class: ModelManager

Called when this mode gets enabled.

Specified by:

onEnabled in class ModelManager<T extends ILookup>

removeSelection

public void removeSelection(T item)

Removes an item from the current selection.

Parameters:

item - The item whose selection decorator will be removed.

setModel

public final void setModel(IObservableCollection<T> value)

Sets the model that describes the domain for the selection.

Only item contained in this model can be rendered as selected.

Parameters:

value - The Model to set.

See Also:

getModel()

setSelectionModel

public final void setSelectionModel(ISelectionModel<T> value)

Sets the selection model that determines which items are selected.

May be null, in which case no elements are considered selected.

Parameters:

value - The SelectionModel to set.

See Also:

getSelectionModel()