Packagecom.adobe.coreUI.controls.whiteboardClasses.shapes
Classpublic class WBCustomShapeFactory
Implementscom.adobe.coreUI.controls.whiteboardClasses.IWBShapeFactory


Public Properties
 PropertyDefined by
  cursor : Class
The cursor that is to be diplayed when the shape is selected.
WBCustomShapeFactory
  factoryId : String
[read-only] The factoryId of the shape.
WBCustomShapeFactory
  shape : Class
The shape Class that defines the display and action properties of the custom shape.
WBCustomShapeFactory
  toolBar : IWBPropertiesToolBar
The ToolBar of the shape
WBCustomShapeFactory
Protected Properties
 PropertyDefined by
  _customCursor : Class
WBCustomShapeFactory
  _customShape : Class
WBCustomShapeFactory
  _factoryId : String
WBCustomShapeFactory
  _shapeData : Object
WBCustomShapeFactory
  _toolBar : IWBPropertiesToolBar
WBCustomShapeFactory
Public Methods
 MethodDefined by
  
WBCustomShapeFactory(p_customShape:Class, p_customCursor:Class = null, p_customToolBar:IWBPropertiesToolBar = null)
Constructor.
WBCustomShapeFactory
  
newShape():WBShapeBase
Return a new custom Shape Instance registered with the WhiteBoard.
WBCustomShapeFactory
Property detail
cursorproperty
cursor:Class  [read-write]

The cursor that is to be diplayed when the shape is selected.

Implementation
    public function get cursor():Class
    public function set cursor(value:Class):void
_customCursorproperty 
protected var _customCursor:Class
_customShapeproperty 
protected var _customShape:Class
_factoryIdproperty 
protected var _factoryId:String
factoryIdproperty 
factoryId:String  [read-only]

The factoryId of the shape. Usaul value would be Class-Name: Shapes Class-Name

Implementation
    public function get factoryId():String
shapeproperty 
shape:Class  [read-write]

The shape Class that defines the display and action properties of the custom shape.

Implementation
    public function get shape():Class
    public function set shape(value:Class):void
_shapeDataproperty 
protected var _shapeData:Object
_toolBarproperty 
protected var _toolBar:IWBPropertiesToolBar
toolBarproperty 
toolBar:IWBPropertiesToolBar  [read-write]

The ToolBar of the shape

Implementation
    public function get toolBar():IWBPropertiesToolBar
    public function set toolBar(value:IWBPropertiesToolBar):void
Constructor detail
WBCustomShapeFactory()constructor
public function WBCustomShapeFactory(p_customShape:Class, p_customCursor:Class = null, p_customToolBar:IWBPropertiesToolBar = null)

Constructor. WBCustomShapeFactory enables the new custom shape to be registered with the WhiteBoard and set the shapes cursor and its toolBar. The following example shows how a custom shape is added using the WBCustomShapeFactory 

     var triangleShape:WBShapeToolBarDescriptor = new WBShapeToolBarDescriptor(WBShapeToolBarDescriptor.TOOL); //Shape is of type tool
     triangleShape.toolTip ="Triangle";
     triangleShape.shapeFactory = new WBCustomShapeFactory(WBTriangleShape, CURSOR_PEN, new WBTrianglePropertiesToolBar());
     triangleShape.icon = ICON_TRIANGLE;
     toolBar.addCustomShapeToToolBar(triangleShape);

Parameters
p_customShape:Class — The shape Class that defines the display and action properties of the custom shape.
 
p_customCursor:Class (default = null) — The cursor that is to be diplayed when the shape is selected.
 
p_customToolBar:IWBPropertiesToolBar (default = null) — Set the ToolBar to be displayed associated with the shape.
Method detail
newShape()method
public function newShape():WBShapeBase

Return a new custom Shape Instance registered with the WhiteBoard.

Returns
WBShapeBase



2008-2010 Adobe Systems Incorporated. All rights reserved.

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/labs/acrobatcom/com/adobe/coreUI/controls/whiteboardClasses/shapes/WBCustomShapeFactory.html