EventExtraData

java.lang.Object
- org.fireweb.EventExtraData

```
public class EventExtraData
extends java.lang.Object
```
Set of data which are available on browser event.

Version:

2.0

Author:

Piotr Ptak

Constructor Summary

Constructors
Constructor and Description

EventExtraData()

Constructors
Constructor and Description
`EventExtraData()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Boolean`	`getAltKey()` Returns whether or not the "ALT" key was pressed when an event was triggered
`java.lang.Boolean`	`getAltLeft()` Returns true if the left Alt key is down at the time the event fired.
`java.lang.Integer`	`getButton()` Returns an integer value indicating the button that changed state. 0 for standard 'click', usually left button 1 for middle button, usually wheel-click 2 for right button, usually right-click Note that this convention is not followed in Internet Explorer: see QuirksMode for details.
`java.lang.Integer`	`getClientX()` Returns the horizontal coordinate of the mouse pointer when an event was triggered
`java.lang.Integer`	`getClientY()` Returns the vertical coordinate of the mouse pointer when an event was triggered
`java.lang.Boolean`	`getCtrlKey()` Returns whether or not the "CTRL" key was pressed when an event was triggered
`java.lang.Boolean`	`getCtrlLeft()` Returns true if the left or right Control key was pressed at the instant the event fired.
`java.lang.String`	`getKeyCode()` Returns the Unicode value of a non-character key in a keypress event or any key in any other type of keyboard event
`java.lang.Integer`	`getLayerX()` Provide the horizontal (x) coordinate of the mouse at the moment the current event fired.
`java.lang.Integer`	`getLayerY()` Provide the vertical (y) coordinate of the mouse at the moment the current event fired.
`java.lang.Boolean`	`getMetaKey()` Returns true if the keyboard's Meta key (Command key on the Macintosh keyboard) was pressed at the instant the event fired.
`java.lang.Integer`	`getOffsetX()` Provide the left and top coordinates of the mouse pointer relative to the containing element (exclusive of padding, borders, or margins) when the event fired.
`java.lang.Integer`	`getOffsetY()` Provide the left and top coordinates of the mouse pointer relative to the containing element (exclusive of padding, borders, or margins) when the event fired.
`java.lang.Integer`	`getPageX()` Provide the left and top coordinates of the element's content relative to the top-left corner of the page area when the event fired.
`java.lang.Integer`	`getPageY()` Provide the left and top coordinates of the element's content relative to the top-left corner of the page area when the event fired.
`java.lang.Boolean`	`getRepeat()` For an onkeydown event only, returns Boolean true if the key has been down long enough to enter auto-repeat mode.
`java.lang.Integer`	`getScreenX()` Returns the horizontal coordinate of the mouse pointer when an event was triggered
`java.lang.Integer`	`getScreenY()` Returns the vertical coordinate of the mouse pointer when an event was triggered
`java.lang.Boolean`	`getShiftKey()` Returns whether or not the "SHIFT" key was pressed when an event was triggered
`java.lang.Boolean`	`getShiftLeft()` Returns true if the left Shift key was pressed at the instant the event fired.
`java.lang.String`	`getWhich()` Contains the numeric code for a particular key pressed, depending on whether an alphanumeric or non-alphanumeric key was pressed
`protected void`	`setAltKey(java.lang.Boolean altKey)`
`protected void`	`setAltLeft(java.lang.Boolean altLeft)`
`protected void`	`setButton(java.lang.Integer button)`
`protected void`	`setClientX(java.lang.Integer clientX)`
`protected void`	`setClientY(java.lang.Integer clientY)`
`protected void`	`setCtrlKey(java.lang.Boolean ctrlKey)`
`protected void`	`setCtrlLeft(java.lang.Boolean ctrlLeft)`
`protected void`	`setKeyCode(java.lang.String keyCode)`
`protected void`	`setLayerX(java.lang.Integer layerX)`
`protected void`	`setLayerY(java.lang.Integer layerY)`
`protected void`	`setMetaKey(java.lang.Boolean metaKey)`
`protected void`	`setOffsetX(java.lang.Integer offsetX)`
`protected void`	`setOffsetY(java.lang.Integer offsetY)`
`protected void`	`setPageX(java.lang.Integer pageX)`
`protected void`	`setPageY(java.lang.Integer pageY)`
`protected void`	`setRepeat(java.lang.Boolean repeat)`
`protected void`	`setScreenX(java.lang.Integer screenX)`
`protected void`	`setScreenY(java.lang.Integer screenY)`
`protected void`	`setShiftKey(java.lang.Boolean shiftKey)`
`protected void`	`setShiftLeft(java.lang.Boolean shiftLeft)`
`protected void`	`setWhich(java.lang.String which)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EventExtraData
```
public EventExtraData()
```
- Method Detail
  - getButton
```
public java.lang.Integer getButton()
```
    Returns an integer value indicating the button that changed state. 0 for standard 'click', usually left button 1 for middle button, usually wheel-click 2 for right button, usually right-click Note that this convention is not followed in Internet Explorer: see QuirksMode for details. The order of buttons may be different depending on how the pointing device has been configured. Because mouse clicks are frequently intercepted by the user interface, it may be difficult to detect buttons other than those for a standard mouse click (usually the left button) in some circumstances. Users may change the configuration of buttons on their pointing device so that if an event's button property is zero, it may not have been caused by the button that is physically left–most on the pointing device; however, it should behave as if the left button was clicked in the standard button layout.
    
    Returns:
    
    the button
  - setButton
```
protected void setButton(java.lang.Integer button)
```
    Parameters:
    
    button - the button to set
  - getClientX
```
public java.lang.Integer getClientX()
```
    Returns the horizontal coordinate of the mouse pointer when an event was triggered
    
    Returns:
    
    the clientX
  - setClientX
```
protected void setClientX(java.lang.Integer clientX)
```
    Parameters:
    
    clientX - the clientX to set
  - getClientY
```
public java.lang.Integer getClientY()
```
    Returns the vertical coordinate of the mouse pointer when an event was triggered
    
    Returns:
    
    the clientY
  - setClientY
```
protected void setClientY(java.lang.Integer clientY)
```
    Parameters:
    
    clientY - the clientY to set
  - getScreenX
```
public java.lang.Integer getScreenX()
```
    Returns the horizontal coordinate of the mouse pointer when an event was triggered
    
    Returns:
    
    the screenX
  - setScreenX
```
protected void setScreenX(java.lang.Integer screenX)
```
    Parameters:
    
    screenX - the screenX to set
  - getScreenY
```
public java.lang.Integer getScreenY()
```
    Returns the vertical coordinate of the mouse pointer when an event was triggered
    
    Returns:
    
    the screenY
  - setScreenY
```
protected void setScreenY(java.lang.Integer screenY)
```
    Parameters:
    
    screenY - the screenY to set
  - getPageX
```
public java.lang.Integer getPageX()
```
    Provide the left and top coordinates of the element's content relative to the top-left corner of the page area when the event fired. The measurements ignore any scrolling of the page.
    
    Returns:
    
    the pageX
  - setPageX
```
protected void setPageX(java.lang.Integer pageX)
```
    Parameters:
    
    pageX - the pageX to set
  - getPageY
```
public java.lang.Integer getPageY()
```
    Provide the left and top coordinates of the element's content relative to the top-left corner of the page area when the event fired. The measurements ignore any scrolling of the page.
    
    Returns:
    
    the pageY
  - setPageY
```
protected void setPageY(java.lang.Integer pageY)
```
    Parameters:
    
    pageY - the pageY to set
  - getLayerX
```
public java.lang.Integer getLayerX()
```
    Provide the horizontal (x) coordinate of the mouse at the moment the current event fired. These coordinates are relative to the containing layer. If no layers or positionable elements have been defined, the default layer of the base document is used as a reference point, thus equivalent to the pageX and pageY properties. In Netscape 6 and later, these properties are measured relative to the element's own rectangular space for text and password input elements, textarea elements, and select elements
    
    Returns:
    
    the layerX
  - setLayerX
```
protected void setLayerX(java.lang.Integer layerX)
```
    Parameters:
    
    layerX - the layerX to set
  - getLayerY
```
public java.lang.Integer getLayerY()
```
    Provide the vertical (y) coordinate of the mouse at the moment the current event fired. These coordinates are relative to the containing layer. If no layers or positionable elements have been defined, the default layer of the base document is used as a reference point, thus equivalent to the pageX and pageY properties. In Netscape 6 and later, these properties are measured relative to the element's own rectangular space for text and password input elements, textarea elements, and select elements
    
    Returns:
    
    the layerY
  - setLayerY
```
protected void setLayerY(java.lang.Integer layerY)
```
    Parameters:
    
    layerY - the layerY to set
  - getOffsetX
```
public java.lang.Integer getOffsetX()
```
    Provide the left and top coordinates of the mouse pointer relative to the containing element (exclusive of padding, borders, or margins) when the event fired. You can determine the containing element via the offsetParent property.
    
    Returns:
    
    the offsetX
  - setOffsetX
```
protected void setOffsetX(java.lang.Integer offsetX)
```
    Parameters:
    
    offsetX - the offsetX to set
  - getOffsetY
```
public java.lang.Integer getOffsetY()
```
    Provide the left and top coordinates of the mouse pointer relative to the containing element (exclusive of padding, borders, or margins) when the event fired. You can determine the containing element via the offsetParent property.
    
    Returns:
    
    the offsetY
  - setOffsetY
```
protected void setOffsetY(java.lang.Integer offsetY)
```
    Parameters:
    
    offsetY - the offsetY to set
  - getCtrlKey
```
public java.lang.Boolean getCtrlKey()
```
    Returns whether or not the "CTRL" key was pressed when an event was triggered
    
    Returns:
    
    the ctrlKey
  - setCtrlKey
```
protected void setCtrlKey(java.lang.Boolean ctrlKey)
```
    Parameters:
    
    ctrlKey - the ctrlKey to set
  - getCtrlLeft
```
public java.lang.Boolean getCtrlLeft()
```
    Returns true if the left or right Control key was pressed at the instant the event fired.
    
    Returns:
    
    the ctrlLeft
  - setCtrlLeft
```
protected void setCtrlLeft(java.lang.Boolean ctrlLeft)
```
    Parameters:
    
    ctrlLeft - the ctrlLeft to set
  - getAltKey
```
public java.lang.Boolean getAltKey()
```
    Returns whether or not the "ALT" key was pressed when an event was triggered
    
    Returns:
    
    the altKey
  - setAltKey
```
protected void setAltKey(java.lang.Boolean altKey)
```
    Parameters:
    
    altKey - the altKey to set
  - getAltLeft
```
public java.lang.Boolean getAltLeft()
```
    Returns true if the left Alt key is down at the time the event fired.
    
    Returns:
    
    the altLeft
  - setAltLeft
```
protected void setAltLeft(java.lang.Boolean altLeft)
```
    Parameters:
    
    altLeft - the altLeft to set
  - getShiftKey
```
public java.lang.Boolean getShiftKey()
```
    Returns whether or not the "SHIFT" key was pressed when an event was triggered
    
    Returns:
    
    the shiftKey
  - setShiftKey
```
protected void setShiftKey(java.lang.Boolean shiftKey)
```
    Parameters:
    
    shiftKey - the shiftKey to set
  - getShiftLeft
```
public java.lang.Boolean getShiftLeft()
```
    Returns true if the left Shift key was pressed at the instant the event fired.
    
    Returns:
    
    the shiftLeft
  - setShiftLeft
```
protected void setShiftLeft(java.lang.Boolean shiftLeft)
```
    Parameters:
    
    shiftLeft - the shiftLeft to set
  - getMetaKey
```
public java.lang.Boolean getMetaKey()
```
    Returns true if the keyboard's Meta key (Command key on the Macintosh keyboard) was pressed at the instant the event fired.
    
    Returns:
    
    the metaKey
  - setMetaKey
```
protected void setMetaKey(java.lang.Boolean metaKey)
```
    Parameters:
    
    metaKey - the metaKey to set
  - getKeyCode
```
public java.lang.String getKeyCode()
```
    Returns the Unicode value of a non-character key in a keypress event or any key in any other type of keyboard event
    
    Returns:
    
    the keyCode
  - setKeyCode
```
protected void setKeyCode(java.lang.String keyCode)
```
    Parameters:
    
    keyCode - the keyCode to set
  - getWhich
```
public java.lang.String getWhich()
```
    Contains the numeric code for a particular key pressed, depending on whether an alphanumeric or non-alphanumeric key was pressed
    
    Returns:
    
    the which
  - setWhich
```
protected void setWhich(java.lang.String which)
```
    Parameters:
    
    which - the which to set
  - getRepeat
```
public java.lang.Boolean getRepeat()
```
    For an onkeydown event only, returns Boolean true if the key has been down long enough to enter auto-repeat mode. You can prevent auto-repeated keys from being entered into a field with the following example.
    
    Returns:
    
    the repeat
  - setRepeat
```
protected void setRepeat(java.lang.Boolean repeat)
```
    Parameters:
    
    repeat - the repeat to set

Class EventExtraData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EventExtraData

Method Detail

getButton

setButton

getClientX

setClientX

getClientY

setClientY

getScreenX

setScreenX

getScreenY

setScreenY

getPageX

setPageX

getPageY

setPageY

getLayerX

setLayerX

getLayerY

setLayerY

getOffsetX

setOffsetX

getOffsetY

setOffsetY

getCtrlKey

setCtrlKey

getCtrlLeft

setCtrlLeft

getAltKey

setAltKey

getAltLeft

setAltLeft

getShiftKey

setShiftKey

getShiftLeft

setShiftLeft

getMetaKey

setMetaKey

getKeyCode

setKeyCode

getWhich

setWhich

getRepeat

setRepeat