Class WebEvent<T>

java.lang.Object

java.util.EventObject

javafx.event.Event

javafx.scene.web.WebEvent<T>

Type Parameters:

T - the type of the web event

All Implemented Interfaces:

Serializable, Cloneable

public final class WebEvent<T>
extends Event

WebEvent instances are passed into EventHandlers registered with a WebEngine by JavaScript running on a Web page. An event holds a single data item of type T.

Since:

JavaFX 2.0

See Also:

• WebEngine
• WebEngine.setOnAlert(EventHandler)
• WebEngine.setOnResized(EventHandler)
• WebEngine.setOnStatusChanged(EventHandler)
• WebEngine.setOnVisibilityChanged(EventHandler)
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final EventType<WebEvent>	ALERT	This event occurs when a script calls the JavaScript alert function.
static final EventType<WebEvent>	ANY	Common supertype for all Web event types.
static final EventType<WebEvent>	RESIZED	This event occurs when a script changes location of the JavaScript window object.
static final EventType<WebEvent>	STATUS_CHANGED	This event occurs when a script changes status line text.
static final EventType<WebEvent>	VISIBILITY_CHANGED	This event occurs when a script changes visibility of the JavaScript window object.

Fields declared in class Event

consumed, eventType, NULL_SOURCE_TARGET, target

Modifier and Type	Field	Description
protected boolean	consumed	Whether this event has been consumed by any filter or handler.
protected EventType<? extends Event>	eventType	Type of the event.
static final EventTarget	NULL_SOURCE_TARGET	The constant which represents an unknown event source / target.
protected EventTarget	target	Event target that defines the path through which the event will travel when posted.

Fields declared in class EventObject

source

Constructor Summary

Constructors

Constructor	Description
WebEvent(Object source, EventType<WebEvent> type, T data)	Creates a new event object.

Method Summary

Modifier and Type	Method	Description
T	getData()	Returns data item carried by this event.
String	toString()	Returns a string representation of this WebEvent object.

Methods declared in class Event

clone, consume, copyFor, fireEvent, getEventType, getTarget, isConsumed

Modifier and Type	Method	Description
Object	clone()	Creates and returns a copy of this Event.
void	consume()	Marks this Event as consumed.
Event	copyFor(Object newSource, EventTarget newTarget)	Creates and returns a copy of this event with the specified event source and target.
static void	fireEvent(EventTarget eventTarget, Event event)	Fires the specified event.
EventType<? extends Event>	getEventType()	Gets the event type of this event.
EventTarget	getTarget()	Returns the event target of this event.
boolean	isConsumed()	Indicates whether this Event has been consumed by any filter or handler.

Methods declared in class EventObject

getSource

Methods declared in class Object

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

Field Details

ANY

public static final EventType<WebEvent> ANY

Common supertype for all Web event types.

RESIZED

public static final EventType<WebEvent> RESIZED

This event occurs when a script changes location of the JavaScript window object.

STATUS_CHANGED

public static final EventType<WebEvent> STATUS_CHANGED

This event occurs when a script changes status line text.

VISIBILITY_CHANGED

public static final EventType<WebEvent> VISIBILITY_CHANGED

This event occurs when a script changes visibility of the JavaScript window object.

ALERT

public static final EventType<WebEvent> ALERT

This event occurs when a script calls the JavaScript alert function.

Constructor Details

WebEvent

public WebEvent(Object source,
 EventType<WebEvent> type,
 T data)

Creates a new event object.

Parameters:

source - the event source

type - the event type

data - the data item

Method Details

getData

public T getData()

Returns data item carried by this event.

Returns:

the data item

toString

public String toString()

Returns a string representation of this WebEvent object.

Overrides:

toString in class EventObject

Returns:

a string representation of this WebEvent object.