T-Plan Robot Enterprise 3.5.1
Build No. 3.5.1-20140411.1

com.tplan.robot.remoteclient
Class RemoteDesktopServerEvent

java.lang.Object
  extended by java.util.EventObject
      extended by com.tplan.robot.remoteclient.RemoteDesktopServerEvent
All Implemented Interfaces:
RfbConstants, Serializable

public class RemoteDesktopServerEvent
extends EventObject
implements RfbConstants

Desktop client event describes an event on the server side, such as server connect or disconnect, desktop image update, change of the clipboard content on the server side and other.

See Also:
Serialized Form

T-Plan Robot Enterprise, (C) 2009-2014 T-Plan Limited. All rights reserved.


Field Summary
static int SERVER_BELL_EVENT
           
static int SERVER_CLIPBOARD_EVENT
           
static int SERVER_CONNECTED_EVENT
           
static int SERVER_CONNECTING_EVENT
           
static int SERVER_CONNECTION_POOLED
           
static int SERVER_CONNECTION_PROGRESS_EVENT
           
static int SERVER_CONNECTION_REUSED
           
static int SERVER_DISCONNECTED_EVENT
           
static int SERVER_DISCONNECTING_EVENT
           
static int SERVER_GUI_MESSAGE_EVENT
           
static int SERVER_IMAGE_AVAILABLE_EVENT
           
static int SERVER_INIT_EVENT
           
static int SERVER_IO_ERROR_EVENT
           
static int SERVER_PROPERTY_AVAILABLE_EVENT
           
static int SERVER_UPDATE_EVENT
           
 
Fields inherited from class java.util.EventObject
source
 
Fields inherited from interface com.tplan.robot.remoteclient.rfb.RfbConstants
BYTEMASK, CINIT_EXCLUSIVE_DESKTOP, CINIT_SHARE_DESKTOP, ENCODING_COMPRESSION_LEVEL_PSEUDO, ENCODING_COPY_RECT, ENCODING_CORRE, ENCODING_CURSOR_PSEUDO, ENCODING_DESKTOP_SIZE, ENCODING_GII_PSEUDO, ENCODING_HEXTILE, ENCODING_HEXTILE_ANY_SUBRECTS, ENCODING_HEXTILE_BG_SPECIFIED, ENCODING_HEXTILE_FG_SPECIFIED, ENCODING_HEXTILE_RAW, ENCODING_HEXTILE_SUBRECTS_COLORED, ENCODING_JPEG_FINE_GRAINED_PSEUDO, ENCODING_JPEG_SUBSAMPLING_PSEUDO, ENCODING_JPEGQLVL, ENCODING_LASTRECT_PSEUDO, ENCODING_POINTER_POSITION, ENCODING_RAW, ENCODING_RRE, ENCODING_TIGHT, ENCODING_X_CURSOR_PSEUDO, ENCODING_ZLIB, ENCODING_ZLIBHEX, MSG_C2S_CLIENT_CUT_TEXT, MSG_C2S_FIX_COLOR_MAP_ENTRIES, MSG_C2S_FRAMEBUFFER_UPDATE_REQUEST, MSG_C2S_KEY_EVENT, MSG_C2S_POINTER_EVENT, MSG_C2S_SET_ENCODINGS, MSG_C2S_SET_PIXEL_FORMAT, MSG_S2C_BELL, MSG_S2C_COMMUNICATION_ERROR, MSG_S2C_CONNECTED, MSG_S2C_CONNECTING, MSG_S2C_DISCONNECTED, MSG_S2C_DISCONNECTING, MSG_S2C_FRAMEBUFFER_UPDATE, MSG_S2C_SERVER_CUT_TEXT, MSG_S2C_SERVER_INIT, MSG_S2C_SET_COLOR_MAP_ENTRIES, PROTOCOL_VERSION_3_3, PROTOCOL_VERSION_3_7, PROTOCOL_VERSION_3_8, RFB_LISTEN_PORT_OFFSET, RFB_PORT_OFFSET, SECURITY_CDEAN, SECURITY_INVALID, SECURITY_MD5, SECURITY_NONE, SECURITY_RA2, SECURITY_RA2NE, SECURITY_RESPONSE_FAILED, SECURITY_RESPONSE_OK, SECURITY_RESPONSE_TOO_MANY_ATTEMPTS, SECURITY_SASL, SECURITY_TIGHT, SECURITY_TLS, SECURITY_TYPE_NAMES, SECURITY_TYPES, SECURITY_ULTRA, SECURITY_VENCRYPT, SECURITY_VNC_AUTH, SPECIAL_KEY_CODES, VAR_LISTEN, VK_CONTEXT_MENU, VK_WINDOWS
 
Constructor Summary
RemoteDesktopServerEvent(RemoteDesktopClient source, Exception ex)
          Constructor for I/O error events (SERVER_IO_ERROR_EVENT type).
RemoteDesktopServerEvent(RemoteDesktopClient source, int messageType)
          Generic constructor for all event types.
RemoteDesktopServerEvent(RemoteDesktopClient source, int messageType, String text)
          Constructor for server the SERVER_CLIPBOARD_EVENT and SERVER_CONNECTION_PROGRESS_EVENT event types.
RemoteDesktopServerEvent(RemoteDesktopClient source, Rectangle updateRect)
          Constructor for screen update events (SERVER_UPDATE_EVENT type).
RemoteDesktopServerEvent(RemoteDesktopClient source, Rectangle updateRect, boolean initial)
          Constructor for screen update events (SERVER_UPDATE_EVENT type).
RemoteDesktopServerEvent(RemoteDesktopClient source, String clipboardText)
          Constructor for server clipboard update events (SERVER_CLIPBOARD_EVENT type).
RemoteDesktopServerEvent(RemoteDesktopClient source, String propertyName, Object propertyValue)
          Constructor for server clipboard update events (SERVER_PROPERTY_AVAILABLE_EVENT type.
 
Method Summary
 boolean canContinue()
           
 RemoteDesktopClient getClient()
           
 String getClipboardText()
           
 Exception getException()
           
 int getMessageType()
           
 String getProgressMessage()
           
 String getPropertyName()
          Get name of the property received from the server.
 Object getPropertyValue()
          Get value of the property received from the server.
 Resumable getResumable()
           
 Object getSource()
           
 Rectangle getUpdateRect()
           
 long getWhen()
           
 boolean isInitialUpdate()
           
 void setWhen(long when)
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

SERVER_CONNECTING_EVENT

public static final int SERVER_CONNECTING_EVENT
See Also:
Constant Field Values

SERVER_CONNECTED_EVENT

public static final int SERVER_CONNECTED_EVENT
See Also:
Constant Field Values

SERVER_INIT_EVENT

public static final int SERVER_INIT_EVENT
See Also:
Constant Field Values

SERVER_DISCONNECTING_EVENT

public static final int SERVER_DISCONNECTING_EVENT
See Also:
Constant Field Values

SERVER_DISCONNECTED_EVENT

public static final int SERVER_DISCONNECTED_EVENT
See Also:
Constant Field Values

SERVER_IMAGE_AVAILABLE_EVENT

public static final int SERVER_IMAGE_AVAILABLE_EVENT
See Also:
Constant Field Values

SERVER_CONNECTION_PROGRESS_EVENT

public static final int SERVER_CONNECTION_PROGRESS_EVENT
See Also:
Constant Field Values

SERVER_GUI_MESSAGE_EVENT

public static final int SERVER_GUI_MESSAGE_EVENT
See Also:
Constant Field Values

SERVER_CONNECTION_POOLED

public static final int SERVER_CONNECTION_POOLED
See Also:
Constant Field Values

SERVER_CONNECTION_REUSED

public static final int SERVER_CONNECTION_REUSED
See Also:
Constant Field Values

SERVER_UPDATE_EVENT

public static final int SERVER_UPDATE_EVENT
See Also:
Constant Field Values

SERVER_BELL_EVENT

public static final int SERVER_BELL_EVENT
See Also:
Constant Field Values

SERVER_CLIPBOARD_EVENT

public static final int SERVER_CLIPBOARD_EVENT
See Also:
Constant Field Values

SERVER_PROPERTY_AVAILABLE_EVENT

public static final int SERVER_PROPERTY_AVAILABLE_EVENT
See Also:
Constant Field Values

SERVER_IO_ERROR_EVENT

public static final int SERVER_IO_ERROR_EVENT
See Also:
Constant Field Values
Constructor Detail

RemoteDesktopServerEvent

public RemoteDesktopServerEvent(RemoteDesktopClient source,
                                int messageType)
Generic constructor for all event types.

Parameters:
source - event source (a desktop client).
messageType - message type, one of the SERVER_ prefixed constants declared by this class.

RemoteDesktopServerEvent

public RemoteDesktopServerEvent(RemoteDesktopClient source,
                                Rectangle updateRect,
                                boolean initial)
Constructor for screen update events (SERVER_UPDATE_EVENT type).

Parameters:
source - event source (a desktop client).
updateRect - updated screen rectangle.
initial - the value of true indicates the devices depending on the desktop image should eventually resize the view to the actual image dimensions. This flag should be set to true when (1) the connection is initiated and the update is the very first one or (2) when the desktop is dynamically resized, for example through the DesktopSizeEncoding encoding of the RFB protocol.

RemoteDesktopServerEvent

public RemoteDesktopServerEvent(RemoteDesktopClient source,
                                Rectangle updateRect)
Constructor for screen update events (SERVER_UPDATE_EVENT type). It is equal to the RemoteDesktopServerEvent(com.tplan.robot.remoteclient.RemoteDesktopClient, java.awt.Rectangle, boolean) constructor where the initial flag is set to false.

Parameters:
source - event source (a desktop client).
updateRect - updated screen rectangle.

RemoteDesktopServerEvent

public RemoteDesktopServerEvent(RemoteDesktopClient source,
                                String clipboardText)
Constructor for server clipboard update events (SERVER_CLIPBOARD_EVENT type).

Parameters:
source - event source (a desktop client).
clipboardText - the new clipboard text received from the client.

RemoteDesktopServerEvent

public RemoteDesktopServerEvent(RemoteDesktopClient source,
                                String propertyName,
                                Object propertyValue)
Constructor for server clipboard update events (SERVER_PROPERTY_AVAILABLE_EVENT type.

Parameters:
source - event source (a desktop client).
propertyName - the new clipboard text received from the client.

RemoteDesktopServerEvent

public RemoteDesktopServerEvent(RemoteDesktopClient source,
                                int messageType,
                                String text)
Constructor for server the SERVER_CLIPBOARD_EVENT and SERVER_CONNECTION_PROGRESS_EVENT event types.

Parameters:
source - event source (a desktop client).
text - the new clipboard or progress message text.

RemoteDesktopServerEvent

public RemoteDesktopServerEvent(RemoteDesktopClient source,
                                Exception ex)
Constructor for I/O error events (SERVER_IO_ERROR_EVENT type).

Parameters:
source - event source (a desktop client).
ex - the thrown I/O exception.
Method Detail

getMessageType

public int getMessageType()

getUpdateRect

public Rectangle getUpdateRect()

getException

public Exception getException()

getWhen

public long getWhen()

setWhen

public void setWhen(long when)

getClipboardText

public String getClipboardText()

getProgressMessage

public String getProgressMessage()

getClient

public RemoteDesktopClient getClient()

getSource

public Object getSource()
Overrides:
getSource in class EventObject

getResumable

public Resumable getResumable()
Returns:
the resumable

canContinue

public boolean canContinue()

toString

public String toString()
Overrides:
toString in class EventObject

isInitialUpdate

public boolean isInitialUpdate()
Returns:
the initialUpdate

getPropertyName

public String getPropertyName()
Get name of the property received from the server. Applicable just to events of the SERVER_PROPERTY_AVAILABLE_EVENT.

Returns:
the property name.
Since:
3.5.1

getPropertyValue

public Object getPropertyValue()
Get value of the property received from the server. Applicable just to events of the SERVER_PROPERTY_AVAILABLE_EVENT.

Returns:
the property name.
Since:
3.5.1

T-Plan Robot Enterprise 3.5.1
Build No. 3.5.1-20140411.1