Uses of Interface
com.yworks.yfiles.view.ICanvasObject

Packages that use ICanvasObject

Package	Description
com.yworks.yfiles.view	Contains the main UI classes, interfaces, default implementations and support classes that can be used to display IGraph instances.
com.yworks.yfiles.view.input	Contains definitions, default implementations, and support classes that deal with the user interaction in a CanvasControl in general, as well as specialized utility classes and IInputMode implementations that can be used to work with and edit IGraph instances in a GraphControl.

Uses of ICanvasObject in com.yworks.yfiles.view

Subinterfaces of ICanvasObject in com.yworks.yfiles.view

Modifier and Type	Interface and Description
interface	ICanvasObjectGroup This is the interface implemented by the composite building blocks of a scene graph in a CanvasControl.

Methods in com.yworks.yfiles.view that return ICanvasObject

Modifier and Type	Method and Description
ICanvasObject	ICanvasObject.above(ICanvasObject reference) Moves this instance exactly behind the reference item in the referenced item's group rendering list, so that it will be rendered directly above the given reference.
protected ICanvasObject	ModelManager.add(T item) Installs an itemm and adds it to this managers set of managed items.
protected ICanvasObject	FocusIndicatorManager.add(T item) Overridden to do nothing.
ICanvasObject	RectangleIndicatorInstaller.addCanvasObject(ICanvasContext context, ICanvasObjectGroup group, Object item)
ICanvasObject	PointSelectionIndicatorInstaller.addCanvasObject(ICanvasContext context, ICanvasObjectGroup group, Object item)
ICanvasObject	OrientedRectangleIndicatorInstaller.addCanvasObject(ICanvasContext context, ICanvasObjectGroup group, Object item)
ICanvasObject	NodeStyleDecorationInstaller.addCanvasObject(ICanvasContext context, ICanvasObjectGroup group, Object item) Installs a rendering for the item if it is an INode.
ICanvasObject	LabelStyleDecorationInstaller.addCanvasObject(ICanvasContext context, ICanvasObjectGroup group, Object item) Installs a rendering for the item if it is an ILabel.
ICanvasObject	ICanvasObjectInstaller.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.
ICanvasObject	EdgeStyleDecorationInstaller.addCanvasObject(ICanvasContext context, ICanvasObjectGroup group, Object item) Installs a rendering for the item if it is an IEdge.
ICanvasObject	EdgeDecorationInstaller.addCanvasObject(ICanvasContext context, ICanvasObjectGroup group, Object item) Installs a rendering for the item if it is an IEdge that will use the EdgeDecorationInstaller.getBendDrawing(CanvasControl, IEdge) and EdgeDecorationInstaller.getPen(CanvasControl, IEdge) to render the path and bends.
ICanvasObject	ICanvasObjectGroup.addChild(Object userObject, ICanvasObjectDescriptor descriptor) Adds a child element to the scene graph as a child of this group.
ICanvasObject	SelectionIndicatorManager.addSelection(T item) Adds an item to the current selection.
ICanvasObject	ICanvasObject.below(ICanvasObject reference) Moves this instance exactly before the reference item in the referenced item's group rendering list, so that it will be rendered directly behind the given reference.
ICanvasObject	GraphModelManager.getCanvasObject(IModelItem item) Retrieves the ICanvasObject for a given model item managed by this instance.
ICanvasObject	CanvasControl.getCanvasObject(PointD location) Returns the top most canvas object instance that is hit at the given coordinate set.
ICanvasObject	ItemModelManager.getCanvasObject(T item) Retrieves the canvas object that has been registered for the given item or null.
ICanvasObject	ICanvasObjectGroup.getFirst() Returns the first item in the rendering list of this group or null.
ICanvasObject	ICanvasObjectGroup.getLast() Returns the last item in the rendering list of this group or null.
ICanvasObject	ICanvasObject.getNext() Gets the next item in the list of rendered items that is owned by this element's Group.
ICanvasObject	ICanvasObject.getPrevious() Gets the previous item in the list of rendered items that is owned by this element's Group.
protected ICanvasObject	ModelManager.install(T item) Installs a member of the collection into the canvas using the ICanvasObjectDescriptor which is returned by ModelManager.getInstaller(java.lang.Object).
protected ICanvasObject	ItemModelManager.install(T item) Installs a member of the collection into the canvas using the Descriptor.
ICanvasObject	ICanvasObject.lower() Moves this instance one step closer to the beginning of the group rendering list, so that it will be rendered behind its current predecessor.
ICanvasObject	ICanvasObject.raise() Moves this instance one step closer to the end of the group rendering list, so that it will be rendered on top of its current successor.
ICanvasObject	ICanvasObject.toBack() Moves this instance to the beginning of the group rendering list, so that it will be rendered behind all other items in the same group.
ICanvasObject	ICanvasObject.toFront() Moves this instance to the end of the group rendering list, so that it will be rendered in front of all other items in the same group.

Methods in com.yworks.yfiles.view that return types with arguments of type ICanvasObject

Modifier and Type	Method and Description
IEnumerable<ICanvasObject>	CanvasControl.getCanvasObjects() Enumerates over all possible ICanvasObject instances in the tree.
IEnumerable<ICanvasObject>	CanvasControl.getCanvasObjects(ICanvasObjectGroup group) Enumerates over all possible ICanvasObject instances in the tree below the given group.
IEnumerable<ICanvasObject>	CanvasControl.getCanvasObjects(PointD location) Returns a list of all canvas objects in hit order at the given world coordinate location.
IEnumerable<ICanvasObject>	CanvasControl.hitElementsAt(IInputModeContext context, PointD location) Enumerates all hit elements in the canvas below the given group that are accepted by a given filter using a specific ICanvasContext as the argument to the IHitTestable.isHit(IInputModeContext, PointD) method.
IEnumerable<ICanvasObject>	CanvasControl.hitElementsAt(IInputModeContext context, PointD location, ICanvasObjectGroup root) Enumerates all hit elements in the canvas below the given group that are accepted by a given filter using a specific ICanvasContext as the argument to the IHitTestable.isHit(IInputModeContext, PointD) method.
IEnumerable<ICanvasObject>	CanvasControl.hitElementsAt(IInputModeContext context, PointD location, ICanvasObjectGroup root, Predicate<ICanvasObject> filter) Enumerates all hit elements in the canvas below the given group that are accepted by a given filter using a specific ICanvasContext as the argument to the IHitTestable.isHit(IInputModeContext, PointD) method.
IEnumerable<ICanvasObject>	CanvasControl.hitElementsAt(PointD location) Enumerates all hit elements in the canvas below the given group that are accepted by a given filter.
IEnumerable<ICanvasObject>	CanvasControl.hitElementsAt(PointD location, ICanvasObjectGroup root) Enumerates all hit elements in the canvas below the given group that are accepted by a given filter.
IEnumerable<ICanvasObject>	CanvasControl.hitElementsAt(PointD location, ICanvasObjectGroup root, Predicate<ICanvasObject> filter) Enumerates all hit elements in the canvas below the given group that are accepted by a given filter.

Methods in com.yworks.yfiles.view with parameters of type ICanvasObject

Modifier and Type	Method and Description
ICanvasObject	ICanvasObject.above(ICanvasObject reference) Moves this instance exactly behind the reference item in the referenced item's group rendering list, so that it will be rendered directly above the given reference.
ICanvasObject	ICanvasObject.below(ICanvasObject reference) Moves this instance exactly before the reference item in the referenced item's group rendering list, so that it will be rendered directly behind the given reference.
int	CanvasControl.compareRenderOrder(ICanvasObject canvasObject1, ICanvasObject canvasObject2) Compares two ICanvasObject instances that are live in this canvas.
RectD	CanvasControl.getBounds(ICanvasObject canvasObject) Convenience method that calculates the bounds for a given canvas object in the scene graph.
T	ItemModelManager.getItem(ICanvasObject canvasObject) Tries to find the item managed by this instance that is associated with the given canvas object.
T	CollectionModelManager.getItem(ICanvasObject canvasObject)
IModelItem	GraphModelManager.getModelItem(ICanvasObject canvasObject) Retrieves the corresponding IModelItem for the given canvas object.
Node	CanvasControl.getVisual(ICanvasObject canvasObject) Gets the Node that is currently visualizing the given ICanvasObject.
IVisualCreator	CanvasControl.getVisualCreator(ICanvasObject canvasObject) Convenience method that retrieves the IVisualCreator for a given ICanvasObject.
boolean	ICanvasObjectDescriptor.isDirty(ICanvasContext context, ICanvasObject canvasObject) Determines whether the given canvas object is deemed dirty and needs updating.
boolean	DefaultPortCandidateDescriptor.isDirty(ICanvasContext context, ICanvasObject canvasObject)
boolean	CanvasControl.isHit(ICanvasObject canvasObject, PointD location) Convenience method that calculates the hit tests a given canvas object in the scene graph.
protected void	ModelManager.unInstall(ICanvasObject canvasObject) Simple implementation that removes the given ICanvasObject.

Method parameters in com.yworks.yfiles.view with type arguments of type ICanvasObject

Modifier and Type	Method and Description
IEnumerable<ICanvasObject>	CanvasControl.hitElementsAt(IInputModeContext context, PointD location, ICanvasObjectGroup root, Predicate<ICanvasObject> filter) Enumerates all hit elements in the canvas below the given group that are accepted by a given filter using a specific ICanvasContext as the argument to the IHitTestable.isHit(IInputModeContext, PointD) method.
IEnumerable<ICanvasObject>	CanvasControl.hitElementsAt(PointD location, ICanvasObjectGroup root, Predicate<ICanvasObject> filter) Enumerates all hit elements in the canvas below the given group that are accepted by a given filter.

Uses of ICanvasObject in com.yworks.yfiles.view.input

Methods in com.yworks.yfiles.view.input that return ICanvasObject

Modifier and Type	Method and Description
protected ICanvasObject	ReparentStripePositionHandler.createSourceGhostVisualization(IInputModeContext context) Create a visualization for the source region of the reparent gesture.
protected ICanvasObject	ReparentStripePositionHandler.createTargetGhostVisualization(IInputModeContext context, IStripe stripe) Create a visualization for the target region of the reparent gesture.
protected ICanvasObject	ReparentStripePositionHandler.updateSourceVisualization(IInputModeContext context, ICanvasObject targetVisualization, IStripe targetStripe, StripeReparentPolicy reparentPosition) Modifies the source visualization itself.
protected ICanvasObject	ReparentStripePositionHandler.updateTargetVisualization(IInputModeContext context, ICanvasObject targetVisualization, IStripe targetStripe, StripeReparentPolicy reparentPosition, RectD targetBounds) Modifies the target visualization itself.

Methods in com.yworks.yfiles.view.input with parameters of type ICanvasObject

Modifier and Type	Method and Description
protected ICanvasObject	ReparentStripePositionHandler.updateSourceVisualization(IInputModeContext context, ICanvasObject targetVisualization, IStripe targetStripe, StripeReparentPolicy reparentPosition) Modifies the source visualization itself.
protected ICanvasObject	ReparentStripePositionHandler.updateTargetVisualization(IInputModeContext context, ICanvasObject targetVisualization, IStripe targetStripe, StripeReparentPolicy reparentPosition, RectD targetBounds) Modifies the target visualization itself.