Packagecom.adobe.coreUI.controls.whiteboardClasses
Classpublic class WBCanvas
InheritanceWBCanvas Inheritance mx.containers.Canvas

This is a standalone whiteboard canvas component. The various shapes and figures drawn on whiteboard are added as children to this component.


Public Properties
 PropertyDefined by
  currentCursorClass : Class
[read-only] Returns the current class for Cursor.
WBCanvas
  currentPropertiesToolBar : IWBPropertiesToolBar
[read-only] Returns the Properties ToolBar.
WBCanvas
  currentShapeFactory : IWBShapeFactory
[write-only] Sets the current Shape Factory.
WBCanvas
  enableShapeSelection : Boolean
Enables/disables Shape Selection on Canvas.
WBCanvas
  model : WBModel
Sets the model.
WBCanvas
  scaleX : Number
[write-only] Sets the X Scale.
WBCanvas
  scaleY : Number
[write-only] Sets the Y Scale.
WBCanvas
  selectedShapeIDs : Array
Gets the ID's of selected shapes.
WBCanvas
Public Methods
 MethodDefined by
  
addChild(child:DisplayObject):DisplayObject
Adds a shape as a child to the canvas.
WBCanvas
  
addToSelection(p_shapeID:String):void
Add a shape to list of selected shapes.
WBCanvas
  
clearCanvas():void
Clears all shapes and selection from the WBCanvas
WBCanvas
  
clearSelection():void
Clear list of selected shapes.
WBCanvas
  
close():void
API for removing event handlers and cleaning up the canvas
WBCanvas
  
getShapeContainer(p_shapeID:String):WBShapeContainer
Returns the container of the given shape.
WBCanvas
  
redo():void
Redo whiteboard command.
WBCanvas
  
registerFactory(p_factory:IWBShapeFactory):void
Registers the factory class for creating the shape.
WBCanvas
  
removeFromSelection(p_shapeID:String):void
Remove a shape from list of selected shapes.
WBCanvas
  
removeSelectedShapes():void
Delete all selected shapes.
WBCanvas
  
undo():void
Undo whiteboard command.
WBCanvas
Events
 EventSummaryDefined by
  
cursorChange
Dispatched when the type of cursor changes.WBCanvas
  
propertiesToolbarAdd
Dispatched when the property tool bar is added.WBCanvas
  
propertiesToolbarRemove
Dispatched when the property tool bar is removed.WBCanvas
  
selectionChange
Dispatched when one selects a different shape on the canvas.WBCanvas
Property detail
currentCursorClassproperty
currentCursorClass:Class  [read-only]

Returns the current class for Cursor.

Implementation
    public function get currentCursorClass():Class
currentPropertiesToolBarproperty 
currentPropertiesToolBar:IWBPropertiesToolBar  [read-only]

Returns the Properties ToolBar.

Implementation
    public function get currentPropertiesToolBar():IWBPropertiesToolBar
currentShapeFactoryproperty 
currentShapeFactory:IWBShapeFactory  [write-only]

Sets the current Shape Factory.

Implementation
    public function set currentShapeFactory(value:IWBShapeFactory):void
enableShapeSelectionproperty 
enableShapeSelection:Boolean  [read-write]

Enables/disables Shape Selection on Canvas.

Implementation
    public function get enableShapeSelection():Boolean
    public function set enableShapeSelection(value:Boolean):void
modelproperty 
model:WBModel  [read-write]

Sets the model.

Implementation
    public function get model():WBModel
    public function set model(value:WBModel):void
scaleXproperty 
scaleX:Number  [write-only]

Sets the X Scale.

Implementation
    public function set scaleX(value:Number):void
scaleYproperty 
scaleY:Number  [write-only]

Sets the Y Scale.

Implementation
    public function set scaleY(value:Number):void
selectedShapeIDsproperty 
selectedShapeIDs:Array  [read-write]

Gets the ID's of selected shapes.

Implementation
    public function get selectedShapeIDs():Array
    public function set selectedShapeIDs(value:Array):void
Method detail
addChild()method
public override function addChild(child:DisplayObject):DisplayObject

Adds a shape as a child to the canvas.

Parameters
child:DisplayObject

Returns
DisplayObject
addToSelection()method 
public function addToSelection(p_shapeID:String):void

Add a shape to list of selected shapes.

Parameters
p_shapeID:String
clearCanvas()method 
public function clearCanvas():void

Clears all shapes and selection from the WBCanvas

clearSelection()method 
public function clearSelection():void

Clear list of selected shapes.

close()method 
public function close():void

API for removing event handlers and cleaning up the canvas

getShapeContainer()method 
public function getShapeContainer(p_shapeID:String):WBShapeContainer

Returns the container of the given shape.

Parameters
p_shapeID:String

Returns
WBShapeContainer
redo()method 
public function redo():void

Redo whiteboard command.

registerFactory()method 
public function registerFactory(p_factory:IWBShapeFactory):void

Registers the factory class for creating the shape.

Parameters
p_factory:IWBShapeFactory
removeFromSelection()method 
public function removeFromSelection(p_shapeID:String):void

Remove a shape from list of selected shapes.

Parameters
p_shapeID:String
removeSelectedShapes()method 
public function removeSelectedShapes():void

Delete all selected shapes.

undo()method 
public function undo():void

Undo whiteboard command.

Event detail
cursorChangeevent 
Event object type: com.adobe.events.WBCanvasEvent

Dispatched when the type of cursor changes.

propertiesToolbarAddevent  
Event object type: com.adobe.events.WBCanvasEvent

Dispatched when the property tool bar is added.

propertiesToolbarRemoveevent  
Event object type: com.adobe.events.WBCanvasEvent

Dispatched when the property tool bar is removed.

selectionChangeevent  
Event object type: flash.events.Event

Dispatched when one selects a different shape on the canvas.




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/WBCanvas.html