com.adobe.rtc.pods.sharedWhiteBoardClasses.SharedWBModel

	Property	Defined by
		connectSession : IConnectSession The IConnectSession with which this component is associated.	SharedWBModel
		isSynchronized : Boolean [read-only] Dispatches when the collectionNode is synchronized.	SharedWBModel
		sessionDependent : Boolean = false Determines if the model is session dependant	SharedWBModel
		sharedCursorPane : SharedCursorPane SharedCursorPane for the whiteboard	SharedWBModel
		sharedID : String The `sharedID` is the ID of the class	SharedWBModel

	Method	Defined by
		SharedWBModel() Constructor	SharedWBModel
		addShape(p_shape:WBShapeDescriptor):void API for adding an existing shape with a shape ID to the canvas.	SharedWBModel
		canUserDraw(p_userID:String):Boolean returns if an user can create/add a shape	SharedWBModel
		changeShapeProperties(p_shapeID:String, p_properties:*):void API for changing shapeID and property Data	SharedWBModel
		close():void Disposes all listeners to the network and framework classes.	SharedWBModel
		createShape(p_shape:WBShapeDescriptor):void API for creating a new shape.	SharedWBModel
		getIsAdded(p_shapeID:String):Boolean returns if the shape is already added to the canvas...	SharedWBModel
		getNodeConfiguration(p_nodeName:String):NodeConfiguration Gets the NodeConfiguration on a specific node in the WhiteBoardmodel.	SharedWBModel
		getShapeDescriptor(p_shapeID:String):WBShapeDescriptor Returns the shape with the given shape ID if it exists	SharedWBModel
		getShapeIDs():Array Returns array of all shape IDs of shapes currently in the whiteboard	SharedWBModel
		getUserRole(p_userID:String):int User Role of an user who can access/publish on the shared white board model	SharedWBModel
		moveSizeRotateShape(p_shapeID:String, p_x:Number, p_y:Number, p_w:Number, p_h:Number, p_rotation:int):void API for changing shape layout like x,y position width, height, rotation.	SharedWBModel
		removeAllShapes():void Remove all shapes	WBModel
		removeShape(p_shapeID:String):void API for removing a shape with a given shape ID	SharedWBModel
		setNodeConfiguration(p_nodeName:String, p_nodeConfiguration:NodeConfiguration):void Sets the NodeConfiguration on a already defined node in WhiteBoardmodel.	SharedWBModel
		setUserRole(p_userID:String, p_role:Number, p_nodeName:String = null):void When called by an owner, `setUserRole()` sets the role of the specified user on a specific node or the collection Node itself.	SharedWBModel
		subscribe():void Tells the component to begin synchronizing with the service.	SharedWBModel

Summary	Defined by
myRoleChange		SharedWBModel
shapeAdd	Dispatched when the shape is added	SharedWBModel
shapeAdd	Dispatched when the shape is added to the canvas of the whiteboard	WBModel
shapeCreate	Dispatched when the shape is first created	SharedWBModel
shapeCreate	Dispatched when the shape is first created	WBModel
shapePositionSizeRotationChange	Dispatched when the layout of shape i.e.	SharedWBModel
shapePositionSizeRotationChange	Dispatched when the layout of shape i.e.	WBModel
shapePropertiesChange	Dispatched when the propertyData of a shape changes	SharedWBModel
shapePropertiesChange	Dispatched when the propertyData of a shape changes	WBModel
shapeRemove	Dispatched when a shape for e.g.	SharedWBModel
shapeRemove	Dispatched when a shape for e.g.	WBModel
synchronizationChange	Dispatched when the SharedWhiteBoardModel has fully connected and synchronized with the service or when it loses that connection.	SharedWBModel
synchronizationChange	Dispatched when the SharedWhiteBoardModel has fully connected and synchronized with the service or when it loses that connection.	WBModel

Property detail

connectSession

property

connectSession:IConnectSession [read-write]

The IConnectSession with which this component is associated. Note that this may only be set once before subscribe is called; re-sessioning of components is not supported. Defaults to the first IConnectSession created in the application.

Implementation
public function get connectSession():IConnectSession
public function set connectSession(value:IConnectSession):void

isSynchronized

property

isSynchronized:Boolean [read-only]

Dispatches when the collectionNode is synchronized.

This property can be used as the source for data binding.

Implementation
public function get isSynchronized():Boolean

sessionDependent

property

public var sessionDependent:Boolean = false

Determines if the model is session dependant

sharedCursorPane

property

sharedCursorPane:SharedCursorPane [read-write]

SharedCursorPane for the whiteboard

Implementation
public function get sharedCursorPane():SharedCursorPane
public function set sharedCursorPane(value:SharedCursorPane):void

sharedID

property

sharedID:String [read-write]

The sharedID is the ID of the class

Implementation
public function get sharedID():String
public function set sharedID(value:String):void

Constructor detail

SharedWBModel

()

constructor

public function SharedWBModel()

Constructor

Method detail

addShape

()

method

public override function addShape(p_shape:WBShapeDescriptor):void

API for adding an existing shape with a shape ID to the canvas. Input is the shapeDescriptor

Parameters

p_shape:WBShapeDescriptor

canUserDraw

()

method

public function canUserDraw(p_userID:String):Boolean

returns if an user can create/add a shape

Parameters

p_userID:String

Returns

Boolean

changeShapeProperties

()

method

public override function changeShapeProperties(p_shapeID:String, p_properties:*):void

API for changing shapeID and property Data

Parameters

	`p_shapeID:String`

	`p_properties:*`

()

method

public function close():void

Disposes all listeners to the network and framework classes. Recommended for proper garbage collection of the component.

createShape

()

method

public override function createShape(p_shape:WBShapeDescriptor):void

API for creating a new shape. Input is a shapedescriptor object. The shape ID is assigned from the server

Parameters

p_shape:WBShapeDescriptor

getIsAdded

()

method

public override function getIsAdded(p_shapeID:String):Boolean

returns if the shape is already added to the canvas...

Parameters

p_shapeID:String

Returns

Boolean

getNodeConfiguration

()

method

public function getNodeConfiguration(p_nodeName:String):NodeConfiguration

Gets the NodeConfiguration on a specific node in the WhiteBoardmodel. If the node is not defined, it will return null

Parameters

p_nodeName:String — The name of the node.

Returns

NodeConfiguration

getShapeDescriptor

()

method

public override function getShapeDescriptor(p_shapeID:String):WBShapeDescriptor

Returns the shape with the given shape ID if it exists

Parameters

p_shapeID:String

Returns

WBShapeDescriptor

getShapeIDs

()

method

public override function getShapeIDs():Array

Returns array of all shape IDs of shapes currently in the whiteboard

Returns

Array

getUserRole

()

method

public function getUserRole(p_userID:String):int

User Role of an user who can access/publish on the shared white board model

Parameters

p_userID:String — UserID of the user whose role we get to have

Returns

int

moveSizeRotateShape

()

method

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

API for changing shape layout like x,y position width, height, rotation.

Parameters

	`p_shapeID:String`

	`p_x:Number`

	`p_y:Number`

	`p_w:Number`

	`p_h:Number`

	`p_rotation:int`

removeShape

()

method

public override function removeShape(p_shapeID:String):void

API for removing a shape with a given shape ID

Parameters

p_shapeID:String

setNodeConfiguration

()

method

public function setNodeConfiguration(p_nodeName:String, p_nodeConfiguration:NodeConfiguration):void

Sets the NodeConfiguration on a already defined node in WhiteBoardmodel. If the node is not defined, it will not do anything.

Parameters

	`p_nodeName:String` — The node Configuration on a node in the NodeConfiguration.

	`p_nodeConfiguration:NodeConfiguration` — The name of the node.

setUserRole

()

method

public function setUserRole(p_userID:String, p_role:Number, p_nodeName:String = null):void

When called by an owner, setUserRole() sets the role of the specified user on a specific node or the collection Node itself. The following rules apply:

Parameters

	`p_userID:String` — The `userID` of the user to set the role for.

	`p_role:Number` — The new role for that user.

	`p_nodeName:String` (default = `null`) — The nodename, if nothing is specified , it sets on the complete collectionNode

()

method

public function subscribe():void

Tells the component to begin synchronizing with the service. For "headless" components such as this one, this method must be called explicitly.

Event detail

myRoleChange

event

Event object type: com.adobe.events.WBModelEvent

shapeAdd

event

Event object type: com.adobe.events.WBModelEvent

Dispatched when the shape is added

shapeCreate

event

Event object type: com.adobe.events.WBModelEvent

Dispatched when the shape is first created

shapePositionSizeRotationChange

event

Event object type: com.adobe.events.WBModelEvent

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

shapePropertiesChange

event

Event object type: com.adobe.events.WBModelEvent

Dispatched when the propertyData of a shape changes

shapeRemove

event

Event object type: com.adobe.events.WBModelEvent

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

synchronizationChange

event

Event object type: com.adobe.rtc.events.CollectionNodeEvent

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

Current page: http://livedocs.adobe.com/labs/acrobatcom/com/adobe/rtc/pods/sharedWhiteBoardClasses/SharedWBModel.html

AFCS API Reference	All Packages \| All Classes \| Index \| Frames No Frames
Class SharedWBModel	Properties \| Methods \| Events

Package	com.adobe.rtc.pods.sharedWhiteBoardClasses
Class	public class SharedWBModel
Inheritance	SharedWBModel WBModel flash.events.EventDispatcher
Implements	ISessionSubscriber