blob: dccec04470ed38c18c54732861972c431fe46d61 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
/*
* SIP Communicator, the OpenSource Java VoIP and Instant Messaging client.
*
* Distributable under LGPL license.
* See terms of license at gnu.org.
*/
package net.java.sip.communicator.service.protocol.whiteboardobjects;
/**
* Used to access the content of instant whiteboard objects that are sent or
* received via the WhiteboardOperationSet.
* <p>
* WhiteboardObject are created through the <tt>WhiteboardSession</tt> session.
* <p>
*
* All WhiteboardObjects have whiteboard object id.
*
* @author Julien Waechter
* @author Emil Ivov
*/
public interface WhiteboardObject
{
/**
* A type string constant indicating that an object is of type object.
*/
public static final String NAME = "WHITEBOARDOBJECT";
/**
* Returns a String uniquely identifying this WhiteboardObject.
*
* @return a String that uniquely identifies this WhiteboardObject.
*/
public String getID();
/**
* Returns an integer indicating the thickness (represented as number of
* pixels) of this whiteboard object (or its border).
*
* @return the thickness (in pixels) of this object (or its border).
*/
public int getThickness();
/**
* Sets the thickness (in pixels) of this whiteboard object.
*
* @param thickness the number of pixels that this object (or its border)
* should be thick.
*/
public void setThickness(int thickness);
/**
* 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.
*
* @return the RGB value of the color of this object.
*/
public int getColor();
/**
* 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.
*
* @param color the color that we'd like to set on this object (using
* standard RGB encoding).
*/
public void setColor(int color);
}
|
