Packagecom.yworks.canvas
Classpublic class CanvasObjectDescriptorAdapter
ImplementsICanvasObjectDescriptor
SubclassesDefaultPortCandidateDescriptor, LabelStyleDescriptor

Adapter class for the ICanvasObjectDescriptor interface.



Public Methods
 MethodDefined by
  
getBoundsProvider(forUserObject:Object):IBoundsProvider
Returns an implementation of IBoundsProvider that can determine the visible bounds of the rendering of the user object.
CanvasObjectDescriptorAdapter
  
getHitTestable(forUserObject:Object):IHitTestable
Returns an implementation of IHitTestable that can determine whether the rendering of the user object has been hit at a given coordinate.
CanvasObjectDescriptorAdapter
  
getPaintable(forUserObject:Object):IPaintable
Returns an implementation of IPaintable that will render the user object.
CanvasObjectDescriptorAdapter
  
isDirty(obj:ICanvasObject):Boolean
Returns true if the canvas object needs to be repainted.
CanvasObjectDescriptorAdapter
Method detail
getBoundsProvider()method
public function getBoundsProvider(forUserObject:Object):IBoundsProvider

Returns an implementation of IBoundsProvider that can determine the visible bounds of the rendering of the user object.

This method may always return the same instance. By contract, clients will not cache instances returned, but will always call this method before the methods on the instance will be called. This contract enables the use of the fly-weight design pattern. Implementations of this class can always return the same instance and reconfigure this instance upon each call to this method.

Parameters
forUserObject:Object — The user object to query the bounds for

Returns
IBoundsProvider — An implementation or null if the bounds are not known, in which case the bounds are treated as infinite
getHitTestable()method 
public function getHitTestable(forUserObject:Object):IHitTestable

Returns an implementation of IHitTestable that can determine whether the rendering of the user object has been hit at a given coordinate.

This method may always return the same instance. By contract, clients will not cache instances returned, but will always call this method before the methods on the instance will be called.
This contract enables the use of the fly-weight design pattern. Implementations of this class can always return the same instance and reconfigure this instance upon each call to this method.

Parameters
forUserObject:Object — The user object to do the hit testing for

Returns
IHitTestable — An implementation or null if the rendering cannot be hit tested
getPaintable()method 
public function getPaintable(forUserObject:Object):IPaintable

Returns an implementation of IPaintable that will render the user object. This method will always return the same instance. By contract, clients will not cache instances returned, but will always call this method before the methods of the instance will be called.

This contract enables the use of the fly-weight design pattern. Implementations of this class can always return the same instance and reconfigure this instance upon each call to this method.

Parameters
forUserObject:Object — The userObject to paint

Returns
IPaintable — An Implementation or null if nothing shall be painted.
isDirty()method 
public function isDirty(obj:ICanvasObject):Boolean

Returns true if the canvas object needs to be repainted.

Parameters
obj:ICanvasObject — The canvas object.

Returns
Booleantrue if the canvas object needs to be repainted.