Packagecom.yworks.canvas.model
Classpublic class DefaultCanvasGroupProvider
InheritanceDefaultCanvasGroupProvider Inheritance Object

Utility class that provides simple factory methods for ICanvasGroupProvider convenience implementations.



Public Methods
 MethodDefined By
  
DefaultCanvasGroupProvider
  
[static] Creates and returns an instance that always returns the provided group.
DefaultCanvasGroupProvider
  
[static] Creates and returns an instance that will always return the root canvas group for the canvas it will be queried.
DefaultCanvasGroupProvider
  
[static] Creates and returns an instance that will always return the topmost canvas group for the canvas it will be queried.
DefaultCanvasGroupProvider
Constructor Detail
DefaultCanvasGroupProvider()Constructor
public function DefaultCanvasGroupProvider()



Method Detail
createConstant()method
public static function createConstant(group:ICanvasObjectGroup):ICanvasGroupProvider

Creates and returns an instance that always returns the provided group.

The instance returned can be used for the canvas component the group has been created for only.

Parameters

group:ICanvasObjectGroup — The group instance to return.

Returns
ICanvasGroupProvider — A group provider that always returns the given group instance.
createRootProvider()method 
public static function createRootProvider():ICanvasGroupProvider

Creates and returns an instance that will always return the root canvas group for the canvas it will be queried.

The instance returned can be used for any canvas component.

Returns
ICanvasGroupProvider — An instance that will always return the root canvas group.
createTopGroupProvider()method 
public static function createTopGroupProvider():ICanvasGroupProvider

Creates and returns an instance that will always return the topmost canvas group for the canvas it will be queried.

The instance returned can be used for any canvas component.

Returns
ICanvasGroupProvider — A provider that returns the top most group.