pureweb.client.collaboration. PolylineTool

An acetate tool delegate that allows users to draw freeform on a view. The drawn lines do not affect the underlying view.

Method Summary

getMarkupType
Returns the markup type.
isMutuallyExclusive
Returns a Boolean value that indicates whether this tool is mutually exclusive with others.
isOneShot
Returns a Boolean value that indicates whether this instance is a one-shot tool.
onActivated
Activates the polyline tool for the specified view.
onDeactivated
Deactivates the polyline tool for the active view.
onDraw
Draws the accumulated polyline markup.
onViewMouseEvent
Updates the polyline markup based on the current state of the mouse.

Constructor

new PolylineTool()

Initializes a new instance of PolylineTool.

Method Detail

getMarkupType() → {string}

Returns the markup type.

isMutuallyExclusive() → {boolean}

Returns a Boolean value that indicates whether this tool is mutually exclusive with others. Will return true if it is, and false otherwise.

isOneShot() → {boolean}

Returns a Boolean value that indicates whether this instance is a one-shot tool. Will return true if it is, and false otherwise. A one-shot tool does not stay activated; it is immediately deactivated after activation.

onActivated(tool)

Activates the polyline tool for the specified view.
Parameters:
Name Type Description
tool pureweb.client.collaboration.AcetateTool The tool that is being activated.

onDeactivated(tool)

Deactivates the polyline tool for the active view.
Parameters:
Name Type Description
tool pureweb.client.collaboration.AcetateTool The tool that is being deactivated.

onDraw(tool, layer, sessionId, instanceId, markup, defaultColor)

Draws the accumulated polyline markup.
Parameters:
Name Type Description
tool pureweb.client.collaboration.AcetateTool The tool that is drawing.
layer pureweb.client.collaboration.CollaborationLayer The layer.
sessionId string The session's unique identifier.
instanceId string The instance's unique identifier.
markup Element The markup.
defaultColor pureweb.PureWebColor The default color.

onViewMouseEvent(tool, event)

Updates the polyline markup based on the current state of the mouse.
Parameters:
Name Type Description
tool pureweb.client.collaboration.AcetateTool The activated acetate tool.
event Object The details of the mouse event.