PackageWhiteboard.tools
Classpublic class WhiteboardTool



Public Properties
 PropertyDefined by
  canInstanciate : Boolean
If true the shape will be created when selected and the user hits the drawingArea, otherwise nothing will be created.
WhiteboardTool
  customPress : Boolean
If your shape reacts to mouse movement in a way different to setting width and height set this to true and have your tool implement Whiteboard.tools.ICustomPress
WhiteboardTool
  editor : String
Which editor is used to drag and resize the shape.
WhiteboardTool
Public Methods
 MethodDefined by
  
Returns the WhiteboardManager.
WhiteboardTool
  
registerProperty(name:String, requiredForDraw:Boolean):void
Registers a property and wheather its required.
WhiteboardTool
  
Stores the WhiteboardManager for reference via getManager()
WhiteboardTool
Property detail
canInstanciateproperty
public var canInstanciate:Boolean

If true the shape will be created when selected and the user hits the drawingArea, otherwise nothing will be created.

customPressproperty 
public var customPress:Boolean

If your shape reacts to mouse movement in a way different to setting width and height set this to true and have your tool implement Whiteboard.tools.ICustomPress

See also

editorproperty 
public var editor:String

Which editor is used to drag and resize the shape.

Method detail
getManager()method
public function getManager():WhiteboardManager

Returns the WhiteboardManager.

Returns
WhiteboardManager

See also

registerProperty()method 
public function registerProperty(name:String, requiredForDraw:Boolean):void

Registers a property and wheather its required. This must be called for all properties e.g. registerProperty('x', true); It should be called in your tools init() method. We do this because properties on the server are stored numerically as "[shapeID].[propertyID]" = value to save bandwidth and be generic.

Parameters
name:String — name of the property.
 
requiredForDraw:Boolean — true the shape will not draw until this property is set.
setManager()method 
public function setManager(manager:WhiteboardManager):void

Stores the WhiteboardManager for reference via getManager()

Parameters
manager:WhiteboardManager — whiteboard manager which owns this tool given during a tools init method.

See also