net.java.sip.communicator.service.protocol.whiteboardobjects
Interface WhiteboardObject

All Known Subinterfaces:

WhiteboardObjectCircle, WhiteboardObjectEllipse, WhiteboardObjectImage, WhiteboardObjectLine, WhiteboardObjectPath, WhiteboardObjectPolygon, WhiteboardObjectPolyLine, WhiteboardObjectRect, WhiteboardObjectText

All Known Implementing Classes:

WhiteboardObjectCircleJabberImpl, WhiteboardObjectImageJabberImpl, WhiteboardObjectJabberImpl, WhiteboardObjectLineJabberImpl, WhiteboardObjectPathJabberImpl, WhiteboardObjectPolygonJabberImpl, WhiteboardObjectPolyLineJabberImpl, WhiteboardObjectRectJabberImpl, WhiteboardObjectTextJabberImpl, WhiteboardShape, WhiteboardShapeCircle, WhiteboardShapeImage, WhiteboardShapeLine, WhiteboardShapePath, WhiteboardShapePolygon, WhiteboardShapePolyLine, WhiteboardShapeRect, WhiteboardShapeText

public interface WhiteboardObject

Used to access the content of instant whiteboard objects that are sent or received via the WhiteboardOperationSet.

WhiteboardObject are created through the WhiteboardSession session.

All WhiteboardObjects have whiteboard object id.

Author:

Julien Waechter, Emil Ivov

Field Summary

static String

NAME A type string constant indicating that an object is of type object.

Method Summary

int	getColor() Returns an integer representing the color of this object.
String	getID() Returns a String uniquely identifying this WhiteboardObject.
int	getThickness() Returns an integer indicating the thickness (represented as number of pixels) of this whiteboard object (or its border).
void	setColor(int color) Sets the color of this whiteboard object (or rather it's border).
void	setThickness(int thickness) Sets the thickness (in pixels) of this whiteboard object.

Field Detail

NAME

static final String NAME

A type string constant indicating that an object is of type object.

See Also:

Constant Field Values

Method Detail

getID

String getID()

Returns a String uniquely identifying this WhiteboardObject.

Returns:

a String that uniquely identifies this WhiteboardObject.

getThickness

int getThickness()

Returns an integer indicating the thickness (represented as number of pixels) of this whiteboard object (or its border).

Returns:

the thickness (in pixels) of this object (or its border).

setThickness

void setThickness(int thickness)

Sets the thickness (in pixels) of this whiteboard object.

Parameters:

thickness - the number of pixels that this object (or its border) should be thick.

getColor

int getColor()

Returns an integer representing the color of this object. The return value uses standard RGB encoding: bits 24-31 are alpha, 16-23 are red, 8-15 are green, 0-7 are blue.

Returns:

the RGB value of the color of this object.

setColor

void setColor(int color)

Sets the color of this whiteboard object (or rather it's border). The color parameter must be encoded with standard RGB encoding: bits 24-31 are alpha, 16-23 are red, 8-15 are green, 0-7 are blue.

Parameters:

color - the color that we'd like to set on this object (using standard RGB encoding).