Class PTEventUtil

Object
   |
   +--PTEventUtil

class PTEventUtil

Static class containing various event utility methods.

Usage:	
 	PTEventUtil.stopBubbling(window.event);
 

Field Detail

SRC_BUTTON_LEFT

<static> <final> String SRC_BUTTON_LEFT

Constant representing the left-hand mouse button

See Also:

Constant Field Values

SRC_BUTTON_MIDDLE

<static> <final> String SRC_BUTTON_MIDDLE

Constant representing the middle mouse button

See Also:

Constant Field Values

SRC_BUTTON_RIGHT

<static> <final> String SRC_BUTTON_RIGHT

Constant representing the right-hand mouse button

See Also:

Constant Field Values

VERSION

<static> <final> Object VERSION

See Also:

Constant Field Values

PTEventUtil

PTEventUtil()

PTEventUtil static object constructor

Returns:
New PTDOMUtil object. Author Stephan Morais

attachEventListener

<static> void attachEventListener(targetElement, eventName, listenerReference)

Attaches an event handing function to a element

Parameters:
targetElement - element to handle the event
eventName - name of the event being listened for
listenerReference - reference to the event handling function

clickElement

<static> void clickElement(elm)

Programmatically clicks an element and invokes any click event handlers that the element may have

Parameters:
elm - the element to be clicked

detachEventListener

<static> void detachEventListener(targetElement, eventName, listenerReference)

Removes an event handling functio from an element

Parameters:
targetElement - element to handle the event
eventName - name of the event being listened for
listenerReference - reference to the event handling function

getButtonClicked

<static> String getButtonClicked(e)

Returns a constant representing the mouse button clicked

Parameters:
e - an event object

Returns:
The mouse button that was clicked : PTEventUtil.SRC_BUTTON_LEFT || PTEventUtil.SRC_BUTTON_RIGHT || PTEventUtil.SRC_BUTTON_MIDDLE || false

getMouseOutFromElement

<static> Element getMouseOutFromElement(e)

Returns the element that the mouse exited

Parameters:
e - the event object

Returns:
The element in which the mouse was before.

getMouseOutToElement

<static> Element getMouseOutToElement(e)

Returns the element that the mouse exited to

Parameters:
e - the event object

Returns:
The element in which the mouse was before.

getMouseOverFromElement

<static> Element getMouseOverFromElement(e)

Returns the element that the mouse was last hovering over

Parameters:
e - the event object

Returns:
The element in which the mouse was before.

getMouseOverToElement

<static> Element getMouseOverToElement(e)

Returns the element that the mouse is hovering over

Parameters:
e - the event object

Returns:
The element in which the mouse was before.

getMouseX

<static> Number getMouseX(e)

Gets the x position of the mouse event.

Parameters:
e - an event object

Returns:
The X position of the mouse at the time of the event.

getMouseY

<static> Number getMouseY(e)

Gets the y position of the mouse event

Parameters:
e - the event object

Returns:
The Y position of the mouse at the time of the event.

getSrcElement

<static> Element getSrcElement(e)

Returns the source element of an event

Parameters:
e - the event object

Returns:
The element that the event took place on

stopBubbling

<static> void stopBubbling(e)

Cancels event bubbling in IE and Netscape

Parameters:
e - the event (netscape only)