Packagecom.yworks.canvas
Interfacepublic interface ICanvasObjectGroup extends ICanvasObject

This is the interface implemented by the composite building blocks of a canvas object tree in a CanvasComponent. It is meant to group multiple ICanvasObject instances as a logic unit. The interface is not meant to be implemented by application programmers. Instances implementing this interface can be retrieved from the factory methods in the canvas component.


Public Properties
 PropertyDefined By
 Inheriteddescriptor : ICanvasObjectDescriptor
Gets or sets the descriptor instance that interprets the userObject during rendering, hit testing, and bounds calculation.
ICanvasObject
 Inheriteddirty : Boolean
Gets or sets whether the canvas object is dirty and should be repainted.
ICanvasObject
  first : ICanvasObject
[read-only] Returns the first item in the rendering list of this group.
ICanvasObjectGroup
 Inheritedgroup : ICanvasObjectGroup
Gets or sets the parent group of this instance.
ICanvasObject
  last : ICanvasObject
[read-only] Returns the last item in the rendering list of this group.
ICanvasObjectGroup
 Inheritednext : ICanvasObject
[read-only] Gets the next item in the list of rendered items that is owned by this element's group.
ICanvasObject
 Inheritedprevious : ICanvasObject
[read-only] Gets the previous item in the list of rendered items that is owned by this element's group.
ICanvasObject
  size : uint
[read-only] Gets the size, i.e.
ICanvasObjectGroup
 InheriteduserObject : Object
Gets or sets the user object associated with this instance.
ICanvasObject
 Inheritedvisible : Boolean
Gets or sets the visibility state of this instance.
ICanvasObject
Public Methods
 MethodDefined By
 Inherited
after(reference:ICanvasObject):ICanvasObject
Moves this instance exactly behind the reference item in the referenced item's group rendering list, so that it will be painted directly on top of the given reference.
ICanvasObject
 Inherited
before(reference:ICanvasObject):ICanvasObject
Moves this instance exactly before the reference item in the referenced item's group rendering list, so that it will be painted directly behind the given reference.
ICanvasObject
 Inherited
lower():ICanvasObject
Moves this instance one step closer to the beginning of the group rendering list, so that it will be painted behind its current predecessor.
ICanvasObject
 Inherited
raise():ICanvasObject
Moves this instance one step closer to the end of the group rendering list, so that it will be painted on top of its current successor.
ICanvasObject
 Inherited
remove():void
Removes this item from the canvas object tree it currently belongs to.
ICanvasObject
 Inherited
toBack():ICanvasObject
Moves this instance to the beginning of the group rendering list, so that it will be painted behind all other items in the same group.
ICanvasObject
 Inherited
toFront():ICanvasObject
Moves this instance to the end of the group rendering list, so that it will be painted in front of all other items in the same group.
ICanvasObject
Property Detail
firstproperty
first:ICanvasObject  [read-only]

Returns the first item in the rendering list of this group. This is the item that will be rendered first, i.e. behind all of the other items in the rendering list.


Implementation
    public function get first():ICanvasObject
lastproperty 
last:ICanvasObject  [read-only]

Returns the last item in the rendering list of this group. This is the item that will be on top of all other items in the list.


Implementation
    public function get last():ICanvasObject
sizeproperty 
size:uint  [read-only]

Gets the size, i.e. the number of child canvas objects contained in this group.


Implementation
    public function get size():uint




Wed Oct 7 2015, 04:52 PM +02:00