pureweb.client.collaboration. CursorPositionTool

Provides an acetate tool delegate that displays an arrow indicating where the user's mouse is pointing. For more information on the acetate functionality, see AcetateToolDelegate.

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.
isShowLocalCursor
Returns a Boolean value that indicates whether the local session cursor is visible.
onActivated
Activates the cursor position tool for the specified view.
onDeactivated
Deactivates the cursor position tool for the active view.
onDraw
Draws the cursor position markup.
onViewMouseEvent
Updates the cursor position markup with the current cursor coordinates.
setShowLocalCursor
Sets the visibility of the local session cursor.

Constructor

new CursorPositionTool()

Initializes a new instance of CursorPositionTool.

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.

isShowLocalCursor() → {boolean}

Returns a Boolean value that indicates whether the local session cursor is visible. Will return true if the local cursor is shown, or false otherwise.

onActivated(tool)

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

onDeactivated(tool)

Deactivates the cursor position 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 cursor position 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 cursor position markup with the current cursor coordinates.
Parameters:
Name Type Description
tool pureweb.client.collaboration.AcetateTool The activated acetate tool.
event Object The details of the mouse event.

setShowLocalCursor(showLocalCursor)

Sets the visibility of the local session cursor.
Parameters:
Name Type Description
showLocalCursor boolean Set to true to show the local cursor, or to false to hide it.