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

All Superinterfaces:

WhiteboardObject

All Known Implementing Classes:

WhiteboardObjectImageJabberImpl, WhiteboardShapeImage

public interface WhiteboardObjectImage
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

byte[]	getBackgroundImage() Returns a binary array containing the image that should be displayed as the background of this WhiteboardObject.
double	getHeight() Returns the height (in pixels) of the WhiteboardObject.
WhiteboardPoint	getWhiteboardPoint() Returns the coordinates of this whiteboard object.
double	getWidth() Returns the width (in pixels) of the WhiteboardObject.
void	setBackgroundImage(byte[] background) Specifies an image that should be displayed as the background of this object.
void	setHeight(double height) Sets the width (in pixels) of the WhiteboardObject.
void	setWhiteboardPoint(WhiteboardPoint whiteboardPoint) Sets the coordinates of this whiteboard object.
void	setWidth(double width) Sets the width (in pixels) of the WhiteboardObject.

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.

getHeight

double getHeight()

Returns the height (in pixels) of the WhiteboardObject.

Returns:

The height.

getWidth

double getWidth()

Returns the width (in pixels) of the WhiteboardObject.

Returns:

The width.

setHeight

void setHeight(double height)

Sets the width (in pixels) of the WhiteboardObject.

Parameters:

height - The new height.

setWidth

void setWidth(double width)

Sets the width (in pixels) of the WhiteboardObject.

Parameters:

width - The new width.

setBackgroundImage

void setBackgroundImage(byte[] background)

Specifies an image that should be displayed as the background of this object.

Parameters:

background - a binary array containing the image that should be displayed as the object background.

getBackgroundImage

byte[] getBackgroundImage()

Returns a binary array containing the image that should be displayed as the background of this WhiteboardObject.

Returns:

a binary array containing the image that should be displayed as the object background.