org.fujion.event

Class Event

java.lang.Object

org.fujion.event.Event

Direct Known Subclasses:

ChangeEvent, CloseEvent, DropEvent, ForwardedEvent, InputEvent, KeyEvent, LoadEvent, MouseEvent, OpenEvent, PropertychangeEvent, ResizeEvent, StatechangeEvent, TimerEvent

public class Event
extends Object

This is the base class for all events.

Constructor Summary

Constructors

Constructor and Description
Event()
Event(Event source) Copy constructor.
Event(String type) Create an event of the specified type with no target and no data.
Event(String type, BaseComponent target) Create an event of the specified type and target with no data.
Event(String type, BaseComponent target, BaseComponent relatedTarget) Create an event of the specified type, target, and related target with no data.
Event(String type, BaseComponent target, BaseComponent relatedTarget, Object data) Create an event of the specified type, target, related target, and data.
Event(String type, BaseComponent target, Object data) Create an event of the specified type, target, and data.
Event(String type, Event source) Copy constructor, but with explicit type.

Method Summary

Modifier and Type	Method and Description
BaseComponent	getCurrentTarget() Returns the event's current target (the component that handled the event).
Object	getData() Returns arbitrary data associated with the event, if any.
Page	getPage() Returns the page associated with the event.
BaseComponent	getRelatedTarget() Returns the event's related target, if any.
BaseComponent	getTarget() Returns the event's target (the component on which the event occurred).
String	getTargetId() Returns the id of the DOM element that was the actual target of the event.
String	getType() Returns the type of event.
boolean	isStopped() Returns true if propagation has been stopped.
void	stopPropagation() Flags the event to prevent further propagation in the event handler chain.

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

public Event()

Event

public Event(String type)

Create an event of the specified type with no target and no data.

Parameters:

type - The event type.

Event

public Event(String type,
             BaseComponent target)

Create an event of the specified type and target with no data.

Parameters:

type - The event type.

target - The target of the event.

Event

public Event(String type,
             BaseComponent target,
             Object data)

Create an event of the specified type, target, and data.

Parameters:

type - The event type.

target - The target of the event.

data - Arbitrary data to associate with the event.

Event

public Event(String type,
             BaseComponent target,
             BaseComponent relatedTarget)

Create an event of the specified type, target, and related target with no data.

Parameters:

type - The event type.

target - The target of the event.

relatedTarget - The related target that participated in the event.

Event

public Event(String type,
             BaseComponent target,
             BaseComponent relatedTarget,
             Object data)

Create an event of the specified type, target, related target, and data.

Parameters:

type - The event type.

target - The target of the event.

relatedTarget - The related target that participated in the event.

data - Arbitrary data to associate with the event.

Event

public Event(Event source)

Copy constructor.

Parameters:

source - Source event to copy.

Event

public Event(String type,
             Event source)

Copy constructor, but with explicit type.

Parameters:

type - Type for new event.

source - Source event to copy.

Method Detail

getPage

public Page getPage()

Returns the page associated with the event.

Returns:

The page associated with the event.

getType

public String getType()

Returns the type of event.

Returns:

The type of event.

getTarget

public BaseComponent getTarget()

Returns the event's target (the component on which the event occurred).

Returns:

The event's target.

getCurrentTarget

public BaseComponent getCurrentTarget()

Returns the event's current target (the component that handled the event).

Returns:

The event's current target.

getRelatedTarget

public BaseComponent getRelatedTarget()

Returns the event's related target, if any. A related target is a secondary component that had some role in or relationship to the event. For example, for a mouseenter event, the target is the component entered; the related target is the component exited.

Returns:

The event's related target

getTargetId

public String getTargetId()

Returns the id of the DOM element that was the actual target of the event. This may be the same as the target's component id, but could also be a sub-element of the target.

Returns:

The target id.

getData

public Object getData()

Returns arbitrary data associated with the event, if any.

Returns:

Arbitrary data associated with the event

stopPropagation

public void stopPropagation()

Flags the event to prevent further propagation in the event handler chain.

isStopped

public boolean isStopped()

Returns true if propagation has been stopped.

Returns:

True if propagation has been stopped.