org.fireweb

Annotation Type EventType

@Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Documented
 @Inherited
public @interface EventType

This class represents browser and user events. Each event has parameters represents by attributes. Action of event type (browser, server) is define by inner enum class "Action". This means which side is responsible for process the event. Way of how to transfer event value from browser to server is define by inner enum class "Value".

Since:

3.2

Version:

1.0

Author:

Piotr Ptak

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	name

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
EventType.Action	actionType Who is doing the action perform when event happened, server or browser.
boolean	browser If this event is triggered by browser.
boolean	bubbling On/off event bubbling.
boolean	callBeforeAfter If true Engine calls FW.beforeEvent function and ajax callBack calls Engine.afterEvent
boolean	extraInfo Do you expect to receive extraInfo information of the browser event.
boolean	feedBack Notify user "event is in progress...".
boolean	notifyServer If to notify server when Script browser event had happened.
boolean	preventDefault Cancels the event if it is cancelable, without stopping further propagation of the event.
java.lang.String	script Script of event action process on browser.
EventType.Value	valueType How do you expect to receive value(s) of elements from web browser.

Element Detail

name

public abstract java.lang.String name

Returns:

Event name

browser

public abstract boolean browser

If this event is triggered by browser. Default is true.

Returns:

if event will process on browser

Default:

true

feedBack

public abstract boolean feedBack

Notify user "event is in progress...". Default is true.

Returns:

if browser will notify server

Default:

true

actionType

public abstract EventType.Action actionType

Who is doing the action perform when event happened, server or browser. Default is "Server".

Returns:

event action type

Default:

org.fireweb.EventType.Action.Server

valueType

public abstract EventType.Value valueType

How do you expect to receive value(s) of elements from web browser. Options are: No, Yes, All Default is "No".

Returns:

event value type

Default:

org.fireweb.EventType.Value.No

extraInfo

public abstract boolean extraInfo

Do you expect to receive extraInfo information of the browser event. Default is false.

Returns:

if event extra info

Default:

false

bubbling

public abstract boolean bubbling

On/off event bubbling. Default is false.

Returns:

if event bubbling

Default:

false

script

public abstract java.lang.String script

Script of event action process on browser. Default is empty script.

Returns:

event JavaScript string

Default:

""

notifyServer

public abstract boolean notifyServer

If to notify server when Script browser event had happened. Default is false.

Returns:

if event notify server

Default:

false

preventDefault

public abstract boolean preventDefault

Cancels the event if it is cancelable, without stopping further propagation of the event. Default is false;

Returns:

if event prevent default

Default:

false

callBeforeAfter

public abstract boolean callBeforeAfter

If true Engine calls FW.beforeEvent function and ajax callBack calls Engine.afterEvent

Returns:

if is calling after/event event action on browser

Default:

false