| Package | com.adobe.rtc.pods |
| Class | public class SharedWhiteBoard |
| Inheritance | SharedWhiteBoard  WhiteBoard mx.core.UIComponent |
| Implements | ISessionSubscriber |
| Property | Defined by | ||
|---|---|---|---|
 | allowSave : Boolean
Returns true if saving is allowed
| WhiteBoard | |
| connectSession : IConnectSession
The IConnectSession with which this component is associated.
| SharedWhiteBoard | ||
| currentPropertiesToolBar : IWBPropertiesToolBar
The current properties tool bar
| WhiteBoard | |
| isSynchronized : Boolean [read-only]
Returns true if the model is synchronized; otherwise, false.
| SharedWhiteBoard | ||
| model : WBModel
[write-only]
| SharedWhiteBoard | ||
| popupPropertiesToolBar : Boolean = true
Returns if the properties tool bar is popped up.
| WhiteBoard | |
| popupShapesToolBar : Boolean = true
Returns if the shapes tool bar is popped up.
| WhiteBoard | |
| sessionDependent : Boolean = false
Whether or not the whiteboard should be cleaned upon the end of the session.
| SharedWhiteBoard | ||
| shapesToolBar : UIComponent
The shapes tool Bar
| WhiteBoard | |
| sharedID : String
Defines the logical location of the component on the service, usually the
sharedID of the collectionNode
the component uses. | SharedWhiteBoard | ||
| zoomLevel : Number
Returns the zoom level
| WhiteBoard | |
| Method | Defined by | ||
|---|---|---|---|
|
close():void
Disposes all listeners to the network and framework classes.
| SharedWhiteBoard | ||
|
getUserRole(p_userID:String):int
Returns the role of a given user for the WhiteBoard.
| SharedWhiteBoard | ||
|
hideSelection():void
Hides the selection container
| WhiteBoard | |
|
registerFactory(p_factory:IWBShapeFactory):void
Registers the factory class for creating a custom shape.
| SharedWhiteBoard | ||
|
setUserRole(p_userID:String, p_userRole:int):void
Sets the role of a given user for the WhiteBoard.
| SharedWhiteBoard | ||
|
showSelection():void
Shows the selection
| WhiteBoard | |
|
subscribe():void
Tells the component to begin synchronizing with the service.
| SharedWhiteBoard | ||
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| Dispatched when one is finished drawing a shape on the canvas. | WhiteBoard | ||
| Dispatched when the property tool bar is added. | WhiteBoard | ||
| Dispatched when the property tool bar is removed. | WhiteBoard | ||
| Dispatched when the whiteboard goes in and out of sync. | SharedWhiteBoard | |||
| connectSession | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesconnectSession: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.
public function get connectSession():IConnectSession
public function set connectSession(value:IConnectSession):void
| isSynchronized | property |
isSynchronized:Boolean [read-only]Returns true if the model is synchronized; otherwise, false.
This property can be used as the source for data binding.
Implementation public function get isSynchronized():Boolean
| model | property |
| sessionDependent | property |
public var sessionDependent:Boolean = falseWhether or not the whiteboard should be cleaned upon the end of the session.
| sharedID | property |
sharedID:String [read-write]
Defines the logical location of the component on the service, usually the sharedID of the collectionNode
the component uses. sharedIDs should be unique within a room if they're expressing two unique locations.
Note that this can only be assigned once and it is assigned before subscribe() is called.
For components with an id property, sharedID defaults to that value.
public function get sharedID():String
public function set sharedID(value:String):void
| close | () | method |
public function close():voidDisposes all listeners to the network and framework classes. Recommended for proper garbage collection of the component.
| getUserRole | () | method |
public function getUserRole(p_userID:String):intReturns the role of a given user for the WhiteBoard.
Parametersp_userID:String — The user ID for the user being queried.
|
int |
| registerFactory | () | method |
public function registerFactory(p_factory:IWBShapeFactory):void
Registers the factory class for creating a custom shape. Custom Shapes are not drawn if the Shapes class is not
registered. The custom shapes are always registered with the SharedWhiteBoard when they are added to the toolBar.
This method is needed when shapes are added programatically or using other UIComponents such as the button.
SharedWhiteBoard.registerFactory(new WBCustomShapeFactory(CustomShape,null,null))
p_factory:IWBShapeFactory |
| setUserRole | () | method |
public function setUserRole(p_userID:String, p_userRole:int):voidSets the role of a given user for the WhiteBoard.
Parametersp_userID:String — The role value to set on the specified user.
|
|
p_userRole:int — The ID of the user whose role should be set.
|
| subscribe | () | method |
public function subscribe():void
Tells the component to begin synchronizing with the service.
For UIComponent-based components such as this one,
subscribe() is called automatically upon being added to the displayList.
For "headless" components, this method must be called explicitly.
| synchronizationChange | event |
com.adobe.rtc.events.CollectionNodeEvent
Dispatched when the whiteboard goes in and out of sync.
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/labs/acrobatcom/com/adobe/rtc/pods/SharedWhiteBoard.html