com.yworks.yfiles.view

Class ModelManager<T>

java.lang.Object

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

Type Parameters:

T - The type of items this instance deals with.

Direct Known Subclasses:

FocusIndicatorManager, HighlightIndicatorManager, SelectionIndicatorManager

public abstract class ModelManager<T>
extends Object

Manages the visual representations of items in a CanvasControl.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ModelManager(CanvasControl canvas) Creates a new instance that will manage the items for the given canvas.

Method Summary

Modifier and Type	Method and Description
protected ICanvasObject	add(T item) Installs an itemm and adds it to this managers set of managed items.
CanvasControl	getCanvas() Gets the canvas instance this instance is managing.
protected abstract ICanvasObjectGroup	getCanvasObjectGroup(T item) Callback used by install(java.lang.Object) to retrieve the canvas object group for a given item.
protected abstract ICanvasObjectInstaller	getInstaller(T item) Callback used by install(java.lang.Object) to retrieve the installer for a given item.
protected ICanvasObject	install(T item) Installs a member of the collection into the canvas using the ICanvasObjectDescriptor which is returned by getInstaller(java.lang.Object).
boolean	isEnabled() Gets whether this ModelManager is enabled.
protected abstract void	onDisabled() Called when this mode gets disabled.
protected abstract void	onEnabled() Called when this mode gets enabled.
protected void	remove(T item) Uninstalls the provided item and removes it from this managers set of managed items.
void	setEnabled(boolean value) Sets whether this ModelManager is enabled.
protected void	unInstall(ICanvasObject canvasObject) Simple implementation that removes the given ICanvasObject.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelManager

protected ModelManager(CanvasControl canvas)

Creates a new instance that will manage the items for the given canvas.

Parameters:

canvas - The canvas to manage.

Method Detail

add

protected ICanvasObject add(T item)

Installs an itemm and adds it to this managers set of managed items.

If Enabled is set to false the item will not be installed.

Parameters:

item - The item to add.

Returns:

The newly created canvas object or null if nothing was installed.

getCanvas

public final CanvasControl getCanvas()

Gets the canvas instance this instance is managing.

Returns:

The Canvas.

getCanvasObjectGroup

protected abstract ICanvasObjectGroup getCanvasObjectGroup(T item)

Callback used by install(java.lang.Object) to retrieve the canvas object group for a given item.

Returning null will cause install(java.lang.Object) not to install anything.

Parameters:

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

Returns:

An ICanvasObjectGroup or null

getInstaller

protected abstract ICanvasObjectInstaller getInstaller(T item)

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

Implementations may use the ILookup.lookup(java.lang.Class) of the item.

Returning null will cause install(java.lang.Object) not to install anything.

Parameters:

item - The item to find an installer for.

Returns:

An installer or null

install

protected ICanvasObject install(T item)

Installs a member of the collection into the canvas using the ICanvasObjectDescriptor which is returned by getInstaller(java.lang.Object).

Parameters:

item - The member to install.

Returns:

The canvas object that has been returned by the installer.

isEnabled

public final boolean isEnabled()

Gets whether this ModelManager is enabled.

If the manager is disabled, it will not install the ICanvasObjects into the associated CanvasControl.

The default is true, i.e. this manager is enabled by default.

Returns:

true if enabled; false otherwise.

See Also:

setEnabled(boolean)

onDisabled

protected abstract void onDisabled()

Called when this mode gets disabled.

onEnabled

protected abstract void onEnabled()

Called when this mode gets enabled.

remove

protected void remove(T item)

Uninstalls the provided item and removes it from this managers set of managed items.

Parameters:

item - The item to remove.

setEnabled

public final void setEnabled(boolean value)

Sets whether this ModelManager is enabled.

If the manager is disabled, it will not install the ICanvasObjects into the associated CanvasControl.

The default is true, i.e. this manager is enabled by default.

Parameters:

value - true if enabled; false otherwise.

See Also:

isEnabled()

unInstall

protected void unInstall(ICanvasObject canvasObject)

Simple implementation that removes the given ICanvasObject.

Parameters:

canvasObject - The canvas objects that have been associated with the descriptor.

See Also:

ICanvasObject.remove()