com.yworks.yfiles.view

Class CollectionModelManager<T>

java.lang.Object

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

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

Type Parameters:

T - The type of items in the observable collection.

public class CollectionModelManager<T>
extends ItemModelManager<T>

An ItemModelManager that automatically installs and removes visual representations of items in a IObservableCollection into or from the canvas.

Constructor Summary

Constructors

Constructor and Description
CollectionModelManager(Class<T> itemType) Creates a new instance.
CollectionModelManager(Class<T> itemType, IObservableCollection<T> model) Creates a new instance using the given model.

Method Summary

Modifier and Type	Method and Description
void	addItem(T item) Registers and installs the given item into the canvas.
T	getItem(ICanvasObject canvasObject) Tries to find the item managed by this instance that is associated with the given canvas object.
IObservableCollection<T>	getModel() Gets the model of the items to display in the canvas.
boolean	isEnabled() Gets a value indicating whether this CollectionModelManager is enabled.
protected void	onDisabled() Called when this mode gets disabled.
protected void	onEnabled() Called when this mode gets enabled.
void	removeItem(T item) Deregisters and uninstalls the given item from the canvas.
void	setEnabled(boolean value) Sets a value indicating whether this CollectionModelManager is enabled.
void	setModel(IObservableCollection<T> value) Sets the model of the items to display in the canvas.
void	update(T item) This method may be called to update the visual representation of the given item in the canvas.

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

addItems, getCanvasObject, getCanvasObjectGroup, getCanvasObjectGroup, getComparator, getDescriptor, getDescriptor, install, itemAddedHandler, itemChangedHandler, itemRemovedHandler, removeItems, setCanvasObjectGroup, setComparator, setDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionModelManager

public CollectionModelManager(Class<T> itemType)

Creates a new instance.

Parameters:

itemType - The type of items in the observable collection.

See Also:

getModel()

CollectionModelManager

public CollectionModelManager(Class<T> itemType,
                              IObservableCollection<T> model)

Creates a new instance using the given model.

Parameters:

itemType - The type of items in the observable collection.

model - The model to manage.

Method Detail

addItem

public void addItem(T item)

Description copied from class: ItemModelManager

Registers and installs the given item into the canvas.

Overrides:

addItem in class ItemModelManager<T>

Parameters:

item - The item to install.

getItem

public T getItem(ICanvasObject canvasObject)

Description copied from class: ItemModelManager

Tries to find the item managed by this instance that is associated with the given canvas object.

Overrides:

getItem in class ItemModelManager<T>

Parameters:

canvasObject - The canvas object to query the corresponding model item for.

Returns:

The item or null if no such item could be found.

getModel

public final IObservableCollection<T> getModel()

Gets the model of the items to display in the canvas.

Setting the model will automatically remove the items installed for a previously installed model. Also the items contained in the new model will immediately be queried and installed into the canvas.

Returns:

The Model.

See Also:

setModel(IObservableCollection)

isEnabled

public final boolean isEnabled()

Gets a value indicating whether this CollectionModelManager is enabled.

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

Returns:

true if enabled; otherwise, false.

See Also:

setEnabled(boolean)

onDisabled

protected void onDisabled()

Called when this mode gets disabled.

onEnabled

protected void onEnabled()

Called when this mode gets enabled.

removeItem

public void removeItem(T item)

Description copied from class: ItemModelManager

Deregisters and uninstalls the given item from the canvas.

Overrides:

removeItem in class ItemModelManager<T>

Parameters:

item - The item to uninstall.

setEnabled

public final void setEnabled(boolean value)

Sets a value indicating whether this CollectionModelManager is enabled.

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

Parameters:

value - true if enabled; otherwise, false.

See Also:

isEnabled()

setModel

public final void setModel(IObservableCollection<T> value)

Sets the model of the items to display in the canvas.

Setting the model will automatically remove the items installed for a previously installed model. Also the items contained in the new model will immediately be queried and installed into the canvas.

Parameters:

value - The Model to set.

See Also:

getModel()

update

public void update(T item)

Description copied from class: ItemModelManager

This method may be called to update the visual representation of the given item in the canvas.

If no visual representation is registered, yet, ItemModelManager.install(Object) will be called.

Overrides:

update in class ItemModelManager<T>

Parameters:

item - The item to update.