com.goldencode.p2j.ui.client.event

Class ServerEvent

java.lang.Object

com.goldencode.p2j.ui.client.event.Event

com.goldencode.p2j.ui.client.event.ServerEvent

All Implemented Interfaces:

Printable, java.io.Externalizable, java.io.Serializable

public class ServerEvent
extends Event
implements java.io.Externalizable

Instances of this class represent a definition of an event which originates from the server side. Currently, the following server-side events are supported:

• Keyboard.PROCEDURE_COMPLETE: raised when an async appserver request is finished

This class also keeps a registry of server-side events posted to the client-side; when the client-side processes the event, the associated ServerEvent instance will be resolved and the event will be executed, using the registered task.

In 4GL, is possible to add user-defined triggers or use the server-events in APPLY statements; testing showed that doing so results in abnormal behavior (as the i.e. parameters, procedure context or the SELF handle can't be resolved).

In current P2J implementation, any server-event names used when defining triggers or in APPLY statements will be treated and will behave as any other UI event; their server-event "flavor" will be hidden and is exposed only when the ServerEvent instances are posted to the event queue via LogicalTerminal.postServerEvent(com.goldencode.p2j.ui.client.event.ServerEvent).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	eventDrawing Set to true to run the event in event-drawing bracket.
private static ContextLocal<java.util.Map<java.lang.Integer,ServerEvent>>	events A registry of server-side events which were posted to the client.
private int	id The id of the event.
private java.lang.String	name The name of this event.
private long	resourceId The resource ID which created the event.
private java.lang.Runnable	task The associated task which will be executed when the event is processed by the client-side.

Constructor Summary

Constructors

Constructor and Description
ServerEvent() Public c'tor added for deserialization purposes only.
ServerEvent(long resourceId, java.lang.String name, java.lang.Runnable task) Create a new server-side event.
ServerEvent(long resourceId, java.lang.String name, java.lang.Runnable task, boolean eventDrawing) Create a new server-side event.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Get the name of this server-event.
int	id() Get the ID of this server-side event.
static void	invoke(int id) Resolve and invoke the event with the given ID.
boolean	isComEvent() Checks if the server event is a COM-EVENT.
boolean	isEventDrawing() Returns the event-drawing flag.
void	print(PrintHelper printer) Print all class-specific fields.
void	readExternal(java.io.ObjectInput in) Initialize this server event instance with the data received from the input source.
static void	removeServerEvents(java.util.Set<java.lang.Integer> eventIds) Remove from the server event queue all the events in the given set, identified by their id.
long	resourceId() Get the resource ID of this server-event.
void	writeExternal(java.io.ObjectOutput out) Send this server-event to the destination.

Methods inherited from class com.goldencode.p2j.ui.client.event.Event

consume, isConsumed, merge, other, source, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.goldencode.util.Printable

asString

Field Detail

events

private static ContextLocal<java.util.Map<java.lang.Integer,ServerEvent>> events

A registry of server-side events which were posted to the client.

id

private int id

The id of the event.

resourceId

private long resourceId

The resource ID which created the event.

name

private java.lang.String name

The name of this event.

task

private java.lang.Runnable task

The associated task which will be executed when the event is processed by the client-side. May be null if the instance is created on the server-side.

eventDrawing

private boolean eventDrawing

Set to true to run the event in event-drawing bracket.

Constructor Detail

ServerEvent

public ServerEvent()

Public c'tor added for deserialization purposes only. Not for public use. This will be invoked only on client-side, when a new server event instance is received. In this case, it is OK for the task field to be null.

ServerEvent

public ServerEvent(long resourceId,
                   java.lang.String name,
                   java.lang.Runnable task)

Create a new server-side event.

Parameters:

resourceId - The id of the resource which created the event.

name - The name of this event.

task - The task associated with this event.

ServerEvent

public ServerEvent(long resourceId,
                   java.lang.String name,
                   java.lang.Runnable task,
                   boolean eventDrawing)

Create a new server-side event.

Parameters:

resourceId - The id of the resource which created the event.

name - The name of this event.

task - The task associated with this event.

eventDrawing - Set to true to run the event in event-drawing bracket. When true the supplied resource id must represent a valid widget.

Method Detail

invoke

public static void invoke(int id)

Resolve and invoke the event with the given ID.

Parameters:

id - The event ID.

removeServerEvents

public static void removeServerEvents(java.util.Set<java.lang.Integer> eventIds)

Remove from the server event queue all the events in the given set, identified by their id.

Parameters:

eventIds - The set of event IDs to be removed.

id

public int id()

Get the ID of this server-side event.

Overrides:

id in class Event

Returns:

The id of this server-side event.

getName

public java.lang.String getName()

Get the name of this server-event.

Returns:

See above.

resourceId

public long resourceId()

Get the resource ID of this server-event.

Returns:

See above.

isEventDrawing

public boolean isEventDrawing()

Returns the event-drawing flag. If true the event is run in event-drawing bracket.

Returns:

see above.

writeExternal

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

Send this server-event to the destination. Only the id, resourceId and name fields will be sent.

Specified by:

writeExternal in interface java.io.Externalizable

Parameters:

out - The output destination to which the server event will be sent.

Throws:

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

readExternal

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

Initialize this server event instance with the data received from the input source.

Specified by:

readExternal in interface java.io.Externalizable

Parameters:

in - The input source from which server event will be restored.

Throws:

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

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

print

public void print(PrintHelper printer)

Print all class-specific fields.

Specified by:

print in interface Printable

Overrides:

print in class Event

Parameters:

printer - the string printer to print into

isComEvent

public boolean isComEvent()

Checks if the server event is a COM-EVENT.

Returns:

true if the event is a COM-EVENT