| Package | com.yworks.canvas |
| Class | public class CanvasObjectDescriptor |
| Inheritance | CanvasObjectDescriptor  Object |
| Implements | ICanvasObjectDescriptor |
ICanvasObjectDescriptor interface.
| Method | Defined By | ||
|---|---|---|---|
[static]
The singleton instance that describes completely dynamic canvas objects
that will always be repainted. | CanvasObjectDescriptor | ||
getBoundsProvider(forUserObject:Object):IBoundsProvider
Returns an implementation of IBoundsProvider that can
determine the visible bounds of the rendering of the user object. | CanvasObjectDescriptor | ||
getDisplayObjectCreator(forUserObject:Object):IDisplayObjectCreator | CanvasObjectDescriptor | ||
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. | CanvasObjectDescriptor | ||
[static]
The singleton instance. | CanvasObjectDescriptor | ||
isDirty(obj:ICanvasObject):Boolean
Returns true if the canvas object needs to be repainted. | CanvasObjectDescriptor | ||
| getAlwaysDirtyInstance | () | method |
public static function getAlwaysDirtyInstance():ICanvasObjectDescriptorThe singleton instance that describes completely dynamic canvas objects that will always be repainted.
ReturnsICanvasObjectDescriptor — The CanvasObjectDescriptor which describes objects that will always be repainted.
|
| 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
|
IBoundsProvider — An implementation or null if the bounds are not known, in which
case the bounds are treated as infinite
|
| getDisplayObjectCreator | () | method |
public function getDisplayObjectCreator(forUserObject:Object):IDisplayObjectCreator
Parameters
forUserObject:Object |
IDisplayObjectCreator |
| 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
|
IHitTestable — An implementation or null if the rendering cannot be hit tested
|
| getInstance | () | method |
public static function getInstance():ICanvasObjectDescriptorThe singleton instance.
ReturnsICanvasObjectDescriptor — The singleton instance of this descriptor.
|
| isDirty | () | method |
public function isDirty(obj:ICanvasObject):Boolean
Returns true if the canvas object needs to be repainted.
Parameters
obj:ICanvasObject — The canvas object.
|
Boolean — true if the canvas object needs to be repainted.
|