org.fireweb

Class EventListener

java.lang.Object

org.fireweb.EventListener

Direct Known Subclasses:

OnAbort, OnBlur, OnBookmark, OnChange, OnClick, OnConfirm, OnCopy, OnCut, OnDblClick, OnDrag, OnDragCancel, OnDraw, OnDrop, OnError, OnEventTimeout, OnException, OnFocus, OnImageLoad, OnKeyDown, OnKeyPress, OnKeyUp, OnLoad, OnLocaleChanged, OnMouseDown, OnMouseMove, OnMouseOut, OnMouseOver, OnMouseUp, OnOverloaded, OnPaste, OnPrompt, OnRequest, OnReset, OnResize, OnSelect, OnSubmit, OnTimer, OnUnload

public abstract class EventListener
extends java.lang.Object

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".

Version:

3.0

Author:

Piotr Ptak

Constructor Summary

Constructors

Constructor and Description
EventListener() Main constructor.

Method Summary

Modifier and Type	Method and Description
EventType.Action	getActionType() Specifies who is doing the action perform when event happened
java.lang.String	getEventName() Script method name associated with the event
java.lang.String	getName() Name of the event
java.lang.String	getScript() Specifies if event bubbling is on/off
EventType.Value	getValueType() Set how do you expect to receive value(s).
boolean	isBrowser() Specifies if this event is triggered by browser.
boolean	isBubbling() Specifies if event bubbling is on/off.
boolean	isCallBeforeAfter()
boolean	isExtraInfo() Specifies if do you expect to receive extraInfo information of the browser event.
boolean	isFeedBack() Specifies if to notify user "event is in progress...".
boolean	isNotifyServer() Specifies If to notify server when Script browser event had happened
boolean	isPreventDefault() Specifies if to cancel default event action on browser.
abstract void	perform(Event event) This method is called if event has happened.
EventListener	setActionType(EventType.Action actionType) Set who is doing the action perform when event happened
EventListener	setBubbling(boolean bubbling) Set if event bubbling is on/off
EventListener	setCallBeforeAfter(boolean callBeforeAfter) Set if Engine will call FW.beforeEvent/Engine.afterEvent
EventListener	setExtraInfo(boolean extraInfo) Set if to receive extraInfo information of the browser event.
EventListener	setFeedBack(boolean feedBack) Set if to notify user "event is in progress..."
EventListener	setNotifyServer(boolean notifyServer) Set if to notify server when Script browser event had happened
EventListener	setPreventDefault(boolean preventDefault) Set if to cancel default event action on browser.
EventListener	setScript(java.lang.String script) Set script to process on browser
EventListener	setValueType(EventType.Value valueType) Specifies how do you expect to receive value(s) of elements from web browser.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventListener

public EventListener()

Main constructor. Copy values from EventType annotation ( EventType ) to this object.

Method Detail

perform

public abstract void perform(Event event)

This method is called if event has happened.

Parameters:

event - Event data.

isExtraInfo

public boolean isExtraInfo()

Specifies if do you expect to receive extraInfo information of the browser event.

Returns:

the extraInfo true or false

setExtraInfo

public EventListener setExtraInfo(boolean extraInfo)

Set if to receive extraInfo information of the browser event.

Parameters:

extraInfo - the extraInfo to set

Returns:

this EventListener

isFeedBack

public boolean isFeedBack()

Specifies if to notify user "event is in progress...".

Returns:

the feedBack

setFeedBack

public EventListener setFeedBack(boolean feedBack)

Set if to notify user "event is in progress..."

Parameters:

feedBack - the feedBack to set

Returns:

this EventListener

getValueType

public EventType.Value getValueType()

Set how do you expect to receive value(s).

Returns:

the value type

setValueType

public EventListener setValueType(EventType.Value valueType)

Specifies how do you expect to receive value(s) of elements from web browser.

Parameters:

valueType - the value to set

Returns:

this EventListener

getName

public java.lang.String getName()

Name of the event

Returns:

the event name

getEventName

public java.lang.String getEventName()

Script method name associated with the event

Returns:

"on" + name

isBrowser

public boolean isBrowser()

Specifies if this event is triggered by browser.

Returns:

if the browser or not

isBubbling

public boolean isBubbling()

Specifies if event bubbling is on/off.

Returns:

the bubbling

setBubbling

public EventListener setBubbling(boolean bubbling)

Set if event bubbling is on/off

Parameters:

bubbling - the bubbling on/off

Returns:

this EventListener

getScript

public java.lang.String getScript()

Specifies if event bubbling is on/off

Returns:

the script

setScript

public EventListener setScript(java.lang.String script)

Set script to process on browser

Parameters:

script - the script to set

Returns:

this EventListener

isNotifyServer

public boolean isNotifyServer()

Specifies If to notify server when Script browser event had happened

Returns:

the notifyServer

setNotifyServer

public EventListener setNotifyServer(boolean notifyServer)

Set if to notify server when Script browser event had happened

Parameters:

notifyServer - the notifyServer to set

Returns:

this EventListener

getActionType

public EventType.Action getActionType()

Specifies who is doing the action perform when event happened

Returns:

the actionType

setActionType

public EventListener setActionType(EventType.Action actionType)

Set who is doing the action perform when event happened

Parameters:

actionType - the actionType to set

Returns:

this EventListener

isPreventDefault

public boolean isPreventDefault()

Specifies if to cancel default event action on browser.

Returns:

the preventDefault

setPreventDefault

public EventListener setPreventDefault(boolean preventDefault)

Set if to cancel default event action on browser.

Parameters:

preventDefault - the preventDefault to set

Returns:

this EventListener

isCallBeforeAfter

public boolean isCallBeforeAfter()

Returns:

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

setCallBeforeAfter

public EventListener setCallBeforeAfter(boolean callBeforeAfter)

Set if Engine will call FW.beforeEvent/Engine.afterEvent

Parameters:

callBeforeAfter - if will be called

Returns:

this EventListener