com.yworks.yfiles.view

Class HighlightIndicatorManager<T extends ILookup>

java.lang.Object

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

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

Type Parameters:

T - The type of the items.

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

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

For each item that should be highlighted this class uses the ILookup mechanism of the items to lookup an IHighlightIndicatorInstaller implementation which will do the actual installation of the decoration in the canvas.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addHighlight(T item) Adds another highlight.
void	clearHighlights() Removes all highlights.
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.
ISelectionModel<T>	getSelectionModel() Gets the selection model that determines which items are highlighted.
protected void	onDisabled() Called when this mode gets disabled.
protected void	onEnabled() Called when this mode gets enabled.
void	removeHighlight(T item) Removes an item from the current highlight selection.
void	setSelectionModel(ISelectionModel<T> value) Sets the selection model that determines which items are highlighted.

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

HighlightIndicatorManager

public HighlightIndicatorManager(CanvasControl canvas)

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

Parameters:

canvas - The canvas to add the selection marks to.

HighlightIndicatorManager

public HighlightIndicatorManager(CanvasControl canvas,
                                 ISelectionModel<T> selectionModel)

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

Parameters:

canvas - The canvas to add the selection marks to.

selectionModel - The model that determines which items are highlighted.

Method Detail

addHighlight

public void addHighlight(T item)

Adds another highlight.

Parameters:

item - The item to highlight.

clearHighlights

public void clearHighlights()

Removes all highlights.

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 HighlightGroup 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 IHighlightIndicatorInstaller instance.

Specified by:

getInstaller in class ModelManager<T extends ILookup>

Parameters:

item - The item to find an installer for.

Returns:

An installer or null

getSelectionModel

public final ISelectionModel<T> getSelectionModel()

Gets the selection model that determines which items are highlighted.

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

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>

removeHighlight

public void removeHighlight(T item)

Removes an item from the current highlight selection.

Parameters:

item - The item whose highlight decorator will be removed.

setSelectionModel

public final void setSelectionModel(ISelectionModel<T> value)

Sets the selection model that determines which items are highlighted.

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

Parameters:

value - The SelectionModel to set.

See Also:

getSelectionModel()