pureweb.client.collaboration

Interface AcetateTool

All Known Implementing Classes:

AcetateToolBase, ClearMarkupTool, CursorPositionTool, PolylineTool

public interface AcetateTool

The AcetateTool class manages an acetate tool delegate that does the actual work of creating and rendering markup. For more information on the acetate functionality, see AcetateToolBase.

Method Summary

Modifier and Type	Method and Description
void	activate(ViewProxy view) Activates the acetate tool for the specified view.
void	cancelMode() Cancels any mode that the tool is in, and ends its current markup.
void	deactivate(ViewProxy view) Deactivates the acetate tool for the specified view.
void	draw(CollaborationLayer layer, java.util.UUID sessionId, java.util.UUID instanceId, org.jdom.Element markup, PureWebColor defaultColor) Draws any data specified in markup.
java.lang.String	getMarkupType() Returns the markup type.
boolean	isMutuallyExclusive() Returns a Boolean value that indicates whether this tool is mutually exclusive with others.
boolean	isOneShot() Returns a Boolean value that indicates whether this instance is a one-shot tool.

Method Detail

getMarkupType

java.lang.String getMarkupType()

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.

draw

void draw(CollaborationLayer layer,
          java.util.UUID sessionId,
          java.util.UUID instanceId,
          org.jdom.Element markup,
          PureWebColor defaultColor)

Draws any data specified in markup. To avoid creating new draw objects on each call, you may consider using a ToolDrawObjectCache, which can store drawing objects based on session ID, view name, and an arbitrary object name.

The drawing operation is carried out independently of any view that the tool is currently activated for.

Parameters:

layer - The collaboration layer containing the markup.

sessionId - The session's unique identifier.

instanceId - The unique identifier of the drawing tool instance.

markup - The markup.

defaultColor - The default color.

cancelMode

void cancelMode()

Cancels any mode that the tool is in, and ends its current markup.

activate

void activate(ViewProxy view)

Activates the acetate tool for the specified view. The tool should connect to any view event or other information sources.

Parameters:

view - The view, represented by a ViewProxy instance.

deactivate

void deactivate(ViewProxy view)

Deactivates the acetate tool for the specified view. The tool should disconnect from any view event and other information sources.

Parameters:

view - The view, represented by a ViewProxy instance.

isMutuallyExclusive

boolean isMutuallyExclusive()

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

isOneShot

boolean isOneShot()

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