com.goldencode.p2j.ui

Class ClientState

java.lang.Object

com.goldencode.p2j.ui.ClientState

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class ClientState
extends java.lang.Object
implements java.io.Externalizable

This class is a container for client-side state.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	activeWindowId The ID of the active window or -1 if unchanged.
WidgetConfigUpdates[]	configUpdates The list of widget configuration updates incoming from the client-side.
int[]	deregister List of frame IDs to deregister.
java.lang.String[]	directUploadFiles An array of file names representing the files uploaded or selected during direct upload.
boolean	directUploadStatus Represents the status of a direct upload.
int[]	down Frame DOWN info.
int[]	downIDs IDs of DOWN frames.
java.lang.String	eventLabel The value of the LAST-EVENT:LABEL attribute.
java.lang.Integer	eventX The value of the LAST-EVENT:X attribute.
java.lang.Integer	eventY The value of the LAST-EVENT:Y attribute.
java.lang.Integer	functionKey The code of last event (LAST-EVENT:FUNCTION)
boolean	hadPause Flag to indicate if there was a pause during the last operation.
(package private) int[]	keyboardState Keyboard pressed keys in no particular order, or null if no keys are pressed
CentralLogRecord[]	logRecords Logger messages.
boolean	resetCursor Flag to indicate the client side reset cursor by mouse move event handling.
java.lang.Integer	virtualLastKey A last-key code which was not set via user input, from the keyboard.
int[]	wrapped IDs of wrapped down frames.

Constructor Summary

Constructors

Constructor and Description
ClientState() Construct an empty instance.

Method Summary

Modifier and Type	Method and Description
void	putKeyboardState(java.util.Set<java.lang.Integer> keyCodes) Update keyboardState field from key code set.
void	readExternal(java.io.ObjectInput in) Replacement for the default object reading method.
void	writeExternal(java.io.ObjectOutput out) Replacement for the default object writing method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

deregister

public int[] deregister

List of frame IDs to deregister.

down

public int[] down

Frame DOWN info.

downIDs

public int[] downIDs

IDs of DOWN frames.

wrapped

public int[] wrapped

IDs of wrapped down frames.

hadPause

public boolean hadPause

Flag to indicate if there was a pause during the last operation.

resetCursor

public boolean resetCursor

Flag to indicate the client side reset cursor by mouse move event handling.

functionKey

public java.lang.Integer functionKey

The code of last event (LAST-EVENT:FUNCTION)

If this the type of this field will be "int" there will be following conflict: not initialized value will be 0, but at the same time 0 - is a valid code of the key (Ctrl-@). The Integer class is used here to distinguish uninitialized value (null) and 0 (valid function code)

eventLabel

public java.lang.String eventLabel

The value of the LAST-EVENT:LABEL attribute.

eventX

public java.lang.Integer eventX

The value of the LAST-EVENT:X attribute.

eventY

public java.lang.Integer eventY

The value of the LAST-EVENT:Y attribute.

virtualLastKey

public java.lang.Integer virtualLastKey

A last-key code which was not set via user input, from the keyboard.

configUpdates

public WidgetConfigUpdates[] configUpdates

The list of widget configuration updates incoming from the client-side.

activeWindowId

public int activeWindowId

The ID of the active window or -1 if unchanged.

logRecords

public CentralLogRecord[] logRecords

Logger messages.

keyboardState

int[] keyboardState

Keyboard pressed keys in no particular order, or null if no keys are pressed

directUploadFiles

public java.lang.String[] directUploadFiles

An array of file names representing the files uploaded or selected during direct upload.

directUploadStatus

public boolean directUploadStatus

Represents the status of a direct upload.

Constructor Detail

ClientState

public ClientState()

Construct an empty instance.

Method Detail

putKeyboardState

public final void putKeyboardState(java.util.Set<java.lang.Integer> keyCodes)

Update keyboardState field from key code set.

Parameters:

keyCodes - the source set

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Replacement for the default object reading method.

Specified by:

readExternal in interface java.io.Externalizable

Parameters:

in - Input source from which fields will be restored.

Throws:

java.io.IOException - In case of I/O errors.

java.lang.ClassNotFoundException - If payload can't be instantiated.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Replacement for the default object writing method.

Specified by:

writeExternal in interface java.io.Externalizable

Parameters:

out - The output destination to which fields will be saved.

Throws:

java.io.IOException - In case of I/O errors.