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

All Superinterfaces:

WhiteboardObject

All Known Implementing Classes:

WhiteboardObjectCircleJabberImpl, WhiteboardShapeCircle

public interface WhiteboardObjectCircle
extends WhiteboardObject

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

Author:

Julien Waechter

Field Summary

static String

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

Method Summary

int	getBackgroundColor() Returns an integer representing the background color of this object.
double	getRadius() Returns the radius (in pixels) of this whiteboard circle.
WhiteboardPoint	getWhiteboardPoint() Returns the coordinates of this whiteboard object.
boolean	isFill() Returns the fill state of the WhiteboardObject.
void	setBackgroundColor(int color) Specifies the background color for this object.
void	setFill(boolean fill) Sets the fill state of the WhiteboardObject.
void	setRadius(double radius) Sets the radius (in pixels) of this whiteboard circle.
void	setWhiteboardPoint(WhiteboardPoint whiteboardPoint) Sets the coordinates of this whiteboard object.

Methods inherited from interface net.java.sip.communicator.service.protocol.whiteboardobjects.WhiteboardObject

getColor, getID, getThickness, setColor, setThickness

Field Detail

NAME

static final String NAME

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

See Also:

Constant Field Values

Method Detail

getWhiteboardPoint

WhiteboardPoint getWhiteboardPoint()

Returns the coordinates of this whiteboard object.

Returns:

the coordinates of this object.

setWhiteboardPoint

void setWhiteboardPoint(WhiteboardPoint whiteboardPoint)

Sets the coordinates of this whiteboard object.

Parameters:

whiteboardPoint - the coordinates of this object.

getRadius

double getRadius()

Returns the radius (in pixels) of this whiteboard circle.

Returns:

the number of pixels for the radius.

setRadius

void setRadius(double radius)

Sets the radius (in pixels) of this whiteboard circle.

Parameters:

radius - the number of pixels for the radius.

isFill

boolean isFill()

Returns the fill state of the WhiteboardObject.

Returns:

True is filled, false is unfilled.

setFill

void setFill(boolean fill)

Sets the fill state of the WhiteboardObject. True is filled, false is unfilled.

Parameters:

fill - The new fill state.

setBackgroundColor

void setBackgroundColor(int color)

Specifies the background color for this object. 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 for the background of this WhiteboardObject (using standard RGB encoding).

getBackgroundColor

int getBackgroundColor()

Returns an integer representing the background 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 background color of this object.