ItemModelManager (yFiles-for-JavaFX-Complete-3.0 API)

java.lang.Object
- com.yworks.yfiles.view.ItemModelManager<T>

Type Parameters:

T - The type of managed items.

Direct Known Subclasses:

CollectionModelManager
```
public class ItemModelManager<T>
extends Object
```
Installs and removes visual representations of items into or from the canvas.

Constructor Summary

Constructors
Constructor and Description

ItemModelManager(Class<T> itemType)

Constructors
Constructor and Description
`ItemModelManager(Class<T> itemType)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addItem(T item)` Registers and `installs` the given `item` into the canvas.
`void`	`addItems(Iterable<T> items)` `Adds` all items to the canvas.
`ICanvasObject`	`getCanvasObject(T item)` Retrieves the canvas object that has been registered for the given item or `null`.
`ICanvasObjectGroup`	`getCanvasObjectGroup()` Gets the canvas object group used by `install(Object)`.
`protected ICanvasObjectGroup`	`getCanvasObjectGroup(T item)` Gets the `ICanvasObjectGroup` used to `install(Object)` the `item` in the canvas.
`Comparator<T>`	`getComparator()` Gets a comparer that compares the items so that they are put into the correct order in the canvas tree.
`ICanvasObjectDescriptor`	`getDescriptor()` Gets the canvas object descriptor used by `install(Object)` when an item is `added` to an canvas object group.
`protected ICanvasObjectDescriptor`	`getDescriptor(T item)` Returns the `ICanvasObjectDescriptor` used to `install(Object)` the `item` in the canvas.
`T`	`getItem(ICanvasObject canvasObject)` Tries to find the item managed by this instance that is associated with the given canvas object.
`protected ICanvasObject`	`install(T item)` Installs a member of the collection into the canvas using the `Descriptor`.
`void`	`itemAddedHandler(Object source, ItemEventArgs<T> args)` Event handler for item creation events that adds the item to this manager.
`void`	`itemChangedHandler(Object source, ItemEventArgs<T> args)` Event handler for item change events that updates the visual representation for that item.
`void`	`itemRemovedHandler(Object source, ItemEventArgs<T> args)` Event handler for item removal events that removes the item from this manager.
`void`	`removeItem(T item)` Deregisters and uninstalls the given `item` from the canvas.
`void`	`removeItems(Iterable<T> items)` `Removes` all items from the canvas.
`void`	`setCanvasObjectGroup(ICanvasObjectGroup value)` Sets the canvas object group used by `install(Object)`.
`void`	`setComparator(Comparator<T> value)` Sets a comparer that compares the items so that they are put into the correct order in the canvas tree.
`void`	`setDescriptor(ICanvasObjectDescriptor value)` Sets the canvas object descriptor used by `install(Object)` when an item is `added` to an canvas object group.
`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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ItemModelManager
```
public ItemModelManager(Class<T> itemType)
```
    Parameters:
    
    itemType - The type of managed items.
- Method Detail
  - addItem
```
public void addItem(T item)
```
    Registers and installs the given item into the canvas.
    
    Parameters:
    
    item - The item to install.
  - addItems
```
public void addItems(Iterable<T> items)
```
    Adds all items to the canvas.
    This is useful to initialize this manager with an existing collection of items.
    
    Parameters:
    
    items - The items to add.
  - getCanvasObject
```
public ICanvasObject getCanvasObject(T item)
```
    Retrieves the canvas object that has been registered for the given item or null.
    
    Parameters:
    
    item - The item to retrieve the canvas object for.
    
    Returns:
    
    A canvas object instance or null.
    
    See Also:
    
    install(Object)
  - getCanvasObjectGroup
```
public final ICanvasObjectGroup getCanvasObjectGroup()
```
    Gets the canvas object group used by install(Object).
    Setting this property to null will prevent this manager from installing new items.
    
    Returns:
    
    The CanvasObjectGroup.
    
    See Also:
    
    setCanvasObjectGroup(ICanvasObjectGroup)
  - getCanvasObjectGroup
```
protected ICanvasObjectGroup getCanvasObjectGroup(T item)
```
    Gets the ICanvasObjectGroup used to install(Object) the item in the canvas.
    The default implementation simply returns the value of CanvasObjectGroup.
    
    Parameters:
    
    item - The item to get the group for.
    
    Returns:
    
    The ICanvasObjectGroup used to install(Object) an item in the canvas.
  - getComparator
```
public final Comparator<T> getComparator()
```
    Gets a comparer that compares the items so that they are put into the correct order in the canvas tree.
    If this instance is set to null this feature is effectively turned off.
    
    Returns:
    
    The Comparator.
    
    See Also:
    
    setComparator(Comparator)
  - getDescriptor
```
public final ICanvasObjectDescriptor getDescriptor()
```
    Gets the canvas object descriptor used by install(Object) when an item is added to an canvas object group.
    Setting the descriptor to null will prevent this manager from installing new items.
    
    Returns:
    
    The canvas object descriptor used by install(Object).
    
    See Also:
    
    setDescriptor(ICanvasObjectDescriptor)
  - getDescriptor
```
protected ICanvasObjectDescriptor getDescriptor(T item)
```
    Returns the ICanvasObjectDescriptor used to install(Object) the item in the canvas.
    The default implementation simply returns the value of Descriptor.
    
    Parameters:
    
    item - The item to get the descriptor for.
    
    Returns:
    
    The ICanvasObjectDescriptor used to install(Object) an item in the canvas.
  - getItem
```
public T getItem(ICanvasObject canvasObject)
```
    Tries to find the item managed by this instance that is associated with the given canvas object.
    
    Parameters:
    
    canvasObject - The canvas object to query the corresponding model item for.
    
    Returns:
    
    The item or null if no such item could be found.
  - install
```
protected ICanvasObject install(T item)
```
    Installs a member of the collection into the canvas using the Descriptor.
    
    Parameters:
    
    item - The member to install.
    
    Returns:
    
    The canvas object that has been returned by the installer.
  - itemAddedHandler
```
public void itemAddedHandler(Object source,
                             ItemEventArgs<T> args)
```
    Event handler for item creation events that adds the item to this manager.
    This method is intended to be used to delegate item creation events from observable collections:
    
    This method calls addItem(Object) with Item.
    
    Parameters:
    
    source - The instance that raised the event.
    
    args - The event arguments.
  - itemChangedHandler
```
public void itemChangedHandler(Object source,
                               ItemEventArgs<T> args)
```
    Event handler for item change events that updates the visual representation for that item.
    This method is intended to be used to delegate item change events from observable collections:
    
    This is necessary if the group the canvas object should be added to might change after the item change. This might happen, e.g. after changing an edge's port in a grouped graph.
    
    Parameters:
    
    source - The event source.
    
    args - The item event args which indicate the change.
  - itemRemovedHandler
```
public void itemRemovedHandler(Object source,
                               ItemEventArgs<T> args)
```
    Event handler for item removal events that removes the item from this manager.
    This method is intended to be used to delegate item removal events from observable collections:
    
    This method calls removeItem(Object) with Item.
    
    Parameters:
    
    source - The instance that raised the event.
    
    args - The event arguments.
  - removeItem
```
public void removeItem(T item)
```
    Deregisters and uninstalls the given item from the canvas.
    
    Parameters:
    
    item - The item to uninstall.
  - removeItems
```
public void removeItems(Iterable<T> items)
```
    Removes all items from the canvas.
    This method can be used to clean up this manager before disposing it.
    
    Parameters:
    
    items - The items to remove.
  - setCanvasObjectGroup
```
public final void setCanvasObjectGroup(ICanvasObjectGroup value)
```
    Sets the canvas object group used by install(Object).
    Setting this property to null will prevent this manager from installing new items.
    
    Parameters:
    
    value - The CanvasObjectGroup to set.
    
    See Also:
    
    getCanvasObjectGroup()
  - setComparator
```
public final void setComparator(Comparator<T> value)
```
    Sets a comparer that compares the items so that they are put into the correct order in the canvas tree.
    If this instance is set to null this feature is effectively turned off.
    
    Parameters:
    
    value - The Comparator to set.
    
    See Also:
    
    getComparator()
  - setDescriptor
```
public final void setDescriptor(ICanvasObjectDescriptor value)
```
    Sets the canvas object descriptor used by install(Object) when an item is added to an canvas object group.
    Setting the descriptor to null will prevent this manager from installing new items.
    
    Parameters:
    
    value - The canvas object descriptor used by install(Object).
    
    See Also:
    
    getDescriptor()
  - update
```
public void update(T item)
```
    This method may be called to update the visual representation of the given item in the canvas.
    If no visual representation is registered, yet, install(Object) will be called.
    
    Parameters:
    
    item - The item to update.

Class ItemModelManager<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ItemModelManager

Method Detail

addItem

addItems

getCanvasObject

getCanvasObjectGroup

getCanvasObjectGroup

getComparator

getDescriptor

getDescriptor

getItem

install

itemAddedHandler

itemChangedHandler

itemRemovedHandler

removeItem

removeItems

setCanvasObjectGroup

setComparator

setDescriptor

update