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

All Superinterfaces:

WhiteboardObject

All Known Implementing Classes:

WhiteboardObjectPolygonJabberImpl, WhiteboardShapePolygon

public interface WhiteboardObjectPolygon
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 polygon.

Method Summary

int	getBackgroundColor() Returns an integer representing the background color of this object.
List<WhiteboardPoint>	getPoints() Returns a list of all the WhiteboardPoint instances that this WhiteboardObject is composed of.
boolean	isFill() 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	setPoints(List<WhiteboardPoint> points) Sets the list of WhiteboardPoint instances that this WhiteboardObject is composed of.

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 polygon.

See Also:

Constant Field Values

Method Detail

isFill

boolean isFill()

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.

getPoints

List<WhiteboardPoint> getPoints()

Returns a list of all the WhiteboardPoint instances that this WhiteboardObject is composed of.

Returns:

the list of WhiteboardPoints composing this object.

setPoints

void setPoints(List<WhiteboardPoint> points)

Sets the list of WhiteboardPoint instances that this WhiteboardObject is composed of.

Parameters:

points - the list of WhiteboardPoint instances that this WhiteboardObject is composed of.

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.