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 AJAX request parameters, apples value and fire events on element.

Version:

2.0

Author:

Piotr Ptak

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBookmark() If event OnBookmark value contains AJAX 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.String	getPrompt() Get string of prompt result of prompt JavaScript function.
Element	getTarget() Get web element which is the target element of the event.
java.lang.String	getTargetElementValue() Looking for value of target element on which event had happen.
java.lang.String	getValue() Looking for value of element on which event had happen.
java.lang.String	getValue(Element wo) Looking for value of element at event values.
java.util.Map<java.lang.String,java.lang.String>	getValues() Unmodifiable map of values received with browser event.
boolean	isConfirmed() The result of confirm JavaScript function
protected void	setBookmark(java.lang.String bookmark)
protected void	setConfirm(java.lang.Boolean confirm)
Event	setData(java.lang.Object data) Set event context data.
protected void	setElement(Element element)
protected void	setPrompt(java.lang.String prompt)
protected void	setTargetWebElement(Element targetWebElement)
protected void	setValues(java.util.Map<java.lang.String,java.lang.String> values)

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

public Event(java.lang.Object data)

Create event object with event context data.

Parameters:

data - Event context data object

Event

public Event(Element element)

Create event object with element event context.

Parameters:

element - context event element

Event

public Event()

Method Detail

getValues

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

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

Returns:

the values

getValue

public java.lang.String 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 java.lang.String 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 java.lang.String 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 AJAX history key (part after # of URL).

Returns:

the browser bookmark hash

getTarget

public Element getTarget()

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

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

setElement

protected void setElement(Element element)

Parameters:

element - the element to set

setTargetWebElement

protected void setTargetWebElement(Element targetWebElement)

Parameters:

targetWebElement - the targetWebElement to set

setValues

protected void setValues(java.util.Map<java.lang.String,java.lang.String> values)

Parameters:

values - the values to set

setConfirm

protected void setConfirm(java.lang.Boolean confirm)

Parameters:

confirm - the confirm to set

setPrompt

protected void setPrompt(java.lang.String prompt)

Parameters:

prompt - the prompt to set

setBookmark

protected void setBookmark(java.lang.String bookmark)

Parameters:

bookmark - the bookmark to set