org.fireweb

Class Event

java.lang.Object

org.fireweb.Event

public final class Event
extends java.lang.Object

Object represents browser event at server. It parses WebSocket data, apples value and fire events on element.

Version:

3.0

Author:

Piotr Ptak

Constructor Summary

Constructors

Constructor and Description
Event(Element element, FireWebApplication application) Create event object with element event context.
Event(FireWebApplication application) Create event object without event context data.
Event(java.lang.Object data, FireWebApplication application) Create event object with event context data.

Method Summary

Modifier and Type	Method and Description
<T extends FireWebApplication> T	getApplication() Context application of the event.
java.lang.String	getBookmark() If event OnBookmark value contains SPA history key (part after # of URL).
<T> T	getData() Get event context data.
<T extends Element> T	getElement() Get element on which event had happen.
java.lang.Class<? extends java.lang.annotation.Annotation>	getEventType()
java.lang.String	getPrompt() Get string of prompt result of prompt JavaScript function.
<T extends Element> T	getTarget() Get web element which is the target element of the event.
org.json.JSONArray	getTargetElementValue() Looking for value of target element on which event had happen.
org.json.JSONArray	getValue() Looking for value of element on which event had happen.
org.json.JSONArray	getValue(Element wo) Looking for value of element at event values.
java.util.Map<java.lang.String,org.json.JSONArray>	getValues() Unmodifiable map of values received with browser event.
boolean	isConfirmed() The result of confirm JavaScript function
Event	setData(java.lang.Object data) Set event context data.

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

public Event(FireWebApplication application)

Create event object without event context data.

Parameters:

application - application context of the event

Event

public Event(java.lang.Object data,
             FireWebApplication application)

Create event object with event context data.

Parameters:

data - Event context data object

application - application context of the event

Event

public Event(Element element,
             FireWebApplication application)

Create event object with element event context.

Parameters:

element - context event element

application - application context of the event

Method Detail

getValues

public java.util.Map<java.lang.String,org.json.JSONArray> getValues()

Unmodifiable map of values received with browser event. Map contains id of object and value of object.

Returns:

the values

getValue

public org.json.JSONArray getValue(Element wo)

Looking for value of element at event values.

Parameters:

wo - StyleElement of which you looking value.

Returns:

Value of the object.

getValue

public org.json.JSONArray getValue()

Looking for value of element on which event had happen.

Returns:

Value of the event element. If no values or no element it returns null.

getTargetElementValue

public org.json.JSONArray getTargetElementValue()

Looking for value of target element on which event had happen.

Returns:

Value of the event element. If no values or no target element know it returns null.

isConfirmed

public boolean isConfirmed()

The result of confirm JavaScript function

Returns:

true if confirm is not null and confirm is true, otherwise returns false.

getPrompt

public java.lang.String getPrompt()

Get string of prompt result of prompt JavaScript function.

Returns:

the prompt string

getBookmark

public java.lang.String getBookmark()

If event OnBookmark value contains SPA history key (part after # of URL).

Returns:

the browser bookmark hash

getTarget

public <T extends Element> T getTarget()

Get web element which is the target element of the event.

Type Parameters:

T - type of element

Returns:

the this type of event's target element

getElement

public <T extends Element> T getElement()

Get element on which event had happen.

Type Parameters:

T - type of element

Returns:

the this type of event's element

getData

public <T> T getData()

Get event context data. It is a object transports to event target element any kind of data

Type Parameters:

T - type of data

Returns:

the this type value of event context data

setData

public Event setData(java.lang.Object data)

Set event context data. It is a object transports to event target element any kind of data.

Parameters:

data - the data to set

Returns:

this

getEventType

public java.lang.Class<? extends java.lang.annotation.Annotation> getEventType()

Returns:

the eventType

getApplication

public <T extends FireWebApplication> T getApplication()

Context application of the event.

Type Parameters:

T - type of element

Returns:

application object