com.yworks.yfiles.view

Interface ICanvasObjectInstaller

All Known Subinterfaces:

IFocusIndicatorInstaller, IHighlightIndicatorInstaller, ISelectionIndicatorInstaller

All Known Implementing Classes:

EdgeDecorationInstaller, EdgeFocusIndicatorInstaller, EdgeHighlightIndicatorInstaller, EdgeSelectionIndicatorInstaller, EdgeStyleDecorationInstaller, LabelStyleDecorationInstaller, NodeStyleDecorationInstaller, OrientedRectangleIndicatorInstaller, PointSelectionIndicatorInstaller, RectangleIndicatorInstaller

public interface ICanvasObjectInstaller

Installs visual representations of items in a CanvasControl.

This interface is most prominently used by ModelManager and its descendants to manage visuals in the canvas.

Method Summary

Modifier and Type	Method and Description
ICanvasObject	addCanvasObject(ICanvasContext context, ICanvasObjectGroup group, Object item) This the main method of the interface that performs the installation of an item's visual representation in the canvas by adding ICanvasObjects.

Method Detail

addCanvasObject

ICanvasObject addCanvasObject(ICanvasContext context,
                              ICanvasObjectGroup group,
                              Object item)

This the main method of the interface that performs the installation of an item's visual representation in the canvas by adding ICanvasObjects.

Parameters:

context - The context that contains the information required to install the visual representation.

group - The canvas object group to add the newly generated ICanvasObject to.

item - The item to install.

Returns:

The newly generated ICanvasObject for the item's visual representation. null if nothing was installed.