Packagecom.adobe.coreUI.controls.whiteboardClasses
Classpublic class WBModel
InheritanceWBModel Inheritance flash.events.EventDispatcher
SubclassesSharedWBModel

This class represents the model for the standalone whiteboard. It stores all the shapes, properties and layouts. It has API's for adding, removing and accessing different shapes.

See also

com.adobe.coreUI.controls.WhiteBoard


Public Methods
 MethodDefined by
  
Constructor
WBModel
  
Add a shape to the canvas
WBModel
  
changeShapeProperties(p_shapeID:String, p_properties:*):void
Change the property data of a shape
WBModel
  
Create a Shape
WBModel
  
getIsAdded(p_shapeID:String):Boolean
Returns if the shape is added already on the canvas
WBModel
  
Returns the shape descriptor of a shape ID
WBModel
  
getShapeIDs():Array
Returns array of shape ids
WBModel
  
moveSizeRotateShape(p_shapeID:String, p_x:Number, p_y:Number, p_w:Number, p_h:Number, p_rotation:int):void
Change layout of shape i.e.
WBModel
  
Remove all shapes
WBModel
  
removeShape(p_shapeID:String):void
remove an existing shape given by the shape id
WBModel
Events
 EventSummaryDefined by
   Dispatched when the shape is added to the canvas of the whiteboard WBModel
   Dispatched when the shape is first created WBModel
   Dispatched when the layout of shape i.e.WBModel
   Dispatched when the propertyData of a shape changes WBModel
   Dispatched when a shape for e.g.WBModel
   Dispatched when the SharedWhiteBoardModel has fully connected and synchronized with the service or when it loses that connection.WBModel
Constructor detail
WBModel()constructor
public function WBModel()

Constructor

Method detail
addShape()method
public function addShape(p_shape:WBShapeDescriptor):void

Add a shape to the canvas

Parameters
p_shape:WBShapeDescriptor
changeShapeProperties()method 
public function changeShapeProperties(p_shapeID:String, p_properties:*):void

Change the property data of a shape

Parameters
p_shapeID:String
 
p_properties:*
createShape()method 
public function createShape(p_shape:WBShapeDescriptor):void

Create a Shape

Parameters
p_shape:WBShapeDescriptor
getIsAdded()method 
public function getIsAdded(p_shapeID:String):Boolean

Returns if the shape is added already on the canvas

Parameters
p_shapeID:String

Returns
Boolean
getShapeDescriptor()method 
public function getShapeDescriptor(p_shapeID:String):WBShapeDescriptor

Returns the shape descriptor of a shape ID

Parameters
p_shapeID:String

Returns
WBShapeDescriptor
getShapeIDs()method 
public function getShapeIDs():Array

Returns array of shape ids

Returns
Array
moveSizeRotateShape()method 
public function moveSizeRotateShape(p_shapeID:String, p_x:Number, p_y:Number, p_w:Number, p_h:Number, p_rotation:int):void

Change layout of shape i.e. change x,y ,width,height or rotation of a shape defined by the shape ID

Parameters
p_shapeID:String
 
p_x:Number
 
p_y:Number
 
p_w:Number
 
p_h:Number
 
p_rotation:int
removeAllShapes()method 
public function removeAllShapes():void

Remove all shapes

removeShape()method 
public function removeShape(p_shapeID:String):void

remove an existing shape given by the shape id

Parameters
p_shapeID:String
Event detail
shapeAddevent 
Event object type: com.adobe.events.WBModelEvent

Dispatched when the shape is added to the canvas of the whiteboard

shapeCreateevent  
Event object type: com.adobe.events.WBModelEvent

Dispatched when the shape is first created

shapePositionSizeRotationChangeevent  
Event object type: com.adobe.events.WBModelEvent

Dispatched when the layout of shape i.e. height, width, rotation angle changes

shapePropertiesChangeevent  
Event object type: com.adobe.events.WBModelEvent

Dispatched when the propertyData of a shape changes

shapeRemoveevent  
Event object type: com.adobe.events.WBModelEvent

Dispatched when a shape for e.g. an ellipse, rectangle is removed.

synchronizationChangeevent  
Event object type: flash.events.Event

Dispatched when the SharedWhiteBoardModel has fully connected and synchronized with the service or when it loses that connection.





 

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