com.whitestein.lsps.vaadin.ui.events

Class UIEvent

java.lang.Object

com.whitestein.lsps.vaadin.ui.events.UIEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

UIApplicationEvent, UIAsynchronousTextChangeEvent, UICalendarEvent, UIChartClickEvent, UIFileUploadEvent, UIGeolocationEvent, UIInitEvent, UIMapClickedEvent, UIMarkerClickedEvent, UIMarkerDraggedEvent, UIMenuEvent, UIPopupCloseRequestEvent, UIRendererClickedEvent, UITablePageChangeEvent, UITreeEvent, UIValueChangeEvent, UIWidgetChangeEvent

public class UIEvent
extends Object
implements Serializable

Generic event representing lsps "ui::Event".

Author:

mbj

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected UIComponent	component

Constructor Summary

Constructors

Constructor and Description
UIEvent(UIComponent component, String eventTypeFullName)

Method Summary

Modifier and Type	Method and Description
RecordHolder	getEvent(UIComponent component) Returns the event definition record in the execution context of given component.
protected Map<String,?>	getEventProperties(UIComponent component) Returns initial properties.
RecordType	getEventType()
UIComponent	getLspsComponent() WARNING: after refresh, the component may no longer be present in the component tree (for example, when a table is refreshed and this component is a table child component).
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

component

protected final UIComponent component

Constructor Detail

UIEvent

public UIEvent(UIComponent component,
               String eventTypeFullName)

Parameters:

component - event originator component, not null

eventTypeFullName - not null

Method Detail

getLspsComponent

public UIComponent getLspsComponent()

WARNING: after refresh, the component may no longer be present in the component tree (for example, when a table is refreshed and this component is a table child component).

Returns:

original component the event was fired on, not null.

getEventType

public RecordType getEventType()

Returns:

the event type

getEvent

public RecordHolder getEvent(UIComponent component)

Returns the event definition record in the execution context of given component.

Parameters:

component - the component, not null.

Returns:

event in the listener scope, never null. Subtype of ui::Event

getEventProperties

protected Map<String,?> getEventProperties(UIComponent component)

Returns initial properties. Maps event RecoldHolder field names to unwrapped field values.

Parameters:

component - the execution context of the listener, not null.

Returns:

initial properties, not null

toString

public String toString()

Overrides:

toString in class Object