com.goldencode.p2j.ui.client.event

Class Event

java.lang.Object

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

All Implemented Interfaces:

Printable

Direct Known Subclasses:

ActionEvent, DirectManipulationEvent, FocusEvent, InvocationEvent, ItemEvent, KeyInput, PaintEvent, PortableMouseEvent, ResourceEvent, ScrollEvent, ServerEvent, SyncEvent, WindowActivated, WindowEvent, WindowMoved, WindowResized

public abstract class Event
extends java.lang.Object
implements Printable

Basic event class.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	consumed If true, the keyboard event was processed and consumed.
private int	id Event type ID.
private Widget	other Companion widget, used for ENTER/LEAVE events.
private Widget	source Event source.

Constructor Summary

Constructors

Constructor and Description
Event(Widget source, int id) Constructor.
Event(Widget source, Widget other, int id) Constructor.

Method Summary

Modifier and Type	Method and Description
void	consume() Mark event as consumed.
int	id() Get event ID.
boolean	isConsumed() Check if event is already consumed.
Event	merge(java.util.LinkedList<Event> queue) Merges the current event with already existed events in queue.
Widget	other() Companion widget for this event.
void	print(PrintHelper printer) Print all class-specific fields.
Widget	source() Source widget for this event.
java.lang.String	toString() Returns a string representation of the object.

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

id

private final int id

Event type ID.

source

private final Widget source

Event source.

other

private final Widget other

Companion widget, used for ENTER/LEAVE events.

consumed

private boolean consumed

If true, the keyboard event was processed and consumed.

Constructor Detail

Event

public Event(Widget source,
             int id)

Constructor.

Parameters:

source - Event source.

id - Event type ID.

Event

public Event(Widget source,
             Widget other,
             int id)

Constructor.

Parameters:

source - Event source.

other - Event companion widget.

id - Event type ID.

Method Detail

id

public int id()

Get event ID.

Returns:

event ID.

source

public Widget source()

Source widget for this event.

Returns:

source widget.

other

public Widget other()

Companion widget for this event.

Returns:

companion widget.

consume

public void consume()

Mark event as consumed.

isConsumed

public boolean isConsumed()

Check if event is already consumed.

Returns:

true if event is consumed.

merge

public Event merge(java.util.LinkedList<Event> queue)

Merges the current event with already existed events in queue.

Parameters:

queue - The queue to check for events.

Returns:

NULL if event merged or current event otherwise.

print

public void print(PrintHelper printer)

Print all class-specific fields.

Specified by:

print in interface Printable

Parameters:

printer - the string printer to print into

toString

public java.lang.String toString()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.