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

All Superinterfaces:

WhiteboardObject

public interface WhiteboardObjectEllipse
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 ellipse.

Method Summary

int	getBackgroundColor() Returns an integer representing the background color of this object.
double	getRadiusX() Returns the width radius (in pixels) of this whiteboard ellipse.
double	getRadiusY() Returns the height radius (in pixels) of this whiteboard ellipse.
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	setRadiusX(double radiusX) Sets the width radius (in pixels) of this whiteboard ellipse.
void	setRadiusY(double radiusY) Sets the height radius (in pixels) of this whiteboard ellipse.
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 ellipse.

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.

getRadiusX

double getRadiusX()

Returns the width radius (in pixels) of this whiteboard ellipse.

Returns:

the number of pixels for the width radius.

getRadiusY

double getRadiusY()

Returns the height radius (in pixels) of this whiteboard ellipse.

Returns:

the number of pixels for the height radius.

setRadiusX

void setRadiusX(double radiusX)

Sets the width radius (in pixels) of this whiteboard ellipse.

Parameters:

radiusX - the number of pixels for the width radius.

setRadiusY

void setRadiusY(double radiusY)

Sets the height radius (in pixels) of this whiteboard ellipse.

Parameters:

radiusY - the number of pixels for the height 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.