pureweb.client.collaboration. ClearMarkupTool

Provides a one-shot acetate tool that deletes all markup for the active view (one-shot tools do not stay activated; they are immediately deactivated after activation). The markup is deleted when the tool is activated. For more information on the acetate functionality, see the AcetateToolDelegate interface.

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
Removes all markup for the local session from the activate view.

Constructor

new ClearMarkupTool()

Initializes a new instance of ClearMarkupTool.

Method Detail

getMarkupType() → {string}

Returns the markup type. This must be unique for each type of tool, and identifies the schema of the draw data consumed and generated by this tool.

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)

Removes all markup for the local session from the activate view.
Parameters:
Name Type Description
tool pureweb.client.collaboration.AcetateTool The tool that is being activated.