ice.pilots.html4
Class DOMUIEvent

java.lang.Object
  extended byice.storm.DynamicObject
      extended byice.pilots.html4.DOMEvent
          extended byice.pilots.html4.DOMUIEvent
All Implemented Interfaces:
Event, MouseEvent, UIEvent

public class DOMUIEvent
extends DOMEvent
implements UIEvent, MouseEvent


Field Summary
static short BUTTON_ALL
           
static short BUTTON_LEFT
           
static short BUTTON_LEFT_MIDDLE
           
static short BUTTON_LEFT_RIGHT
           
static short BUTTON_MIDDLE
           
static short BUTTON_NONE
           
static short BUTTON_RIGHT
           
static short BUTTON_RIGHT_MIDDLE
           
 
Fields inherited from class ice.pilots.html4.DOMEvent
ABORT, BLUR, CHANGE, CLICK, CONTEXTMENU, CSSModified, DBLCLICK, defaultActionTarget, doc, DOMAttrModified, DOMNodeInserted, DOMNodeRemoved, DOMSubtreeModified, ERROR, FOCUS, GOTO, HELP, KEYDOWN, KEYPRESS, KEYUP, LOAD, MOUSEDOWN, MOUSEMOVE, MOUSEOUT, MOUSEOVER, MOUSEUP, NUM_EVENTS, RESET, RESIZE, SCROLL, SELECT, SUBMIT, UNLOAD
 
Fields inherited from class ice.storm.DynamicObject
NOT_FOUND, SETD_IGNORE, SETD_NOT_FOUND, SETD_OK
 
Fields inherited from interface org.w3c.dom.events.Event
AT_TARGET, BUBBLING_PHASE, CAPTURING_PHASE
 
Method Summary
protected  void copyUIDataFrom(DOMEvent a_source)
           
 Object execDynamicMethod(String name, Object[] args, DynEnv env)
          Perform function-like actions for `name' with the given args.
 boolean getAltKey()
          Used to indicate whether the 'alt' key was depressed during the firing of the event.
 short getButton()
          During mouse events caused by the depression or release of a mouse button, button is used to indicate which mouse button changed state.
 long getCharCode()
           
 int getClientX()
          The horizontal coordinate at which the event occurred relative to the DOM implementation's client area.
 int getClientY()
          The vertical coordinate at which the event occurred relative to the DOM implementation's client area.
 boolean getCtrlKey()
          Used to indicate whether the 'ctrl' key was depressed during the firing of the event.
 int getDetail()
          Specifies some detail information about the Event, depending on the type of event.
 Object getDynamicValue(String name, DynEnv env)
          Returns the `key' field or Defs.NOT_FOUND if `name' does not exist.
 long getKeyCode()
           
 boolean getMetaKey()
          Used to indicate whether the 'meta' key was depressed during the firing of the event.
 int getModifiers()
           
 short getMouseButtons()
           
 ObjectPainter getObjectPainter()
           
 int getPosX()
           
 int getPosY()
           
 Node getRelatedNode()
           
 EventTarget getRelatedTarget()
          Used to identify a secondary EventTarget related to a UI event.
 int getScreenX()
          The horizontal coordinate at which the event occurred relative to the origin of the screen coordinate system.
 int getScreenY()
          The vertical coordinate at which the event occurred relative to the origin of the screen coordinate system.
 int getScrollX()
           
 int getScrollY()
           
 boolean getShiftKey()
          Used to indicate whether the 'shift' key was depressed during the firing of the event.
 AbstractView getView()
          The view attribute identifies the AbstractView from which the event was generated.
 void initMouseEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg, AbstractView viewArg, int detailArg, int screenXArg, int screenYArg, int clientXArg, int clientYArg, boolean ctrlKeyArg, boolean altKeyArg, boolean shiftKeyArg, boolean metaKeyArg, short buttonArg, EventTarget relatedTargetArg)
          The initMouseEvent method is used to initialize the value of a MouseEvent created through the DocumentEvent interface.
 void initUIEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg, AbstractView viewArg, int detailArg)
          The initUIEvent method is used to initialize the value of a UIEvent created through the DocumentEvent interface.
 boolean isMousePressPopupTrigger()
           
 boolean isPopupTrigger()
           
 boolean isShortcutKey()
           
 void setAltKey(boolean val)
           
 void setButton(short value)
           
 void setCharCode(long cc)
           
 void setClientCoords(int new_x, int new_y, int new_scrollX, int new_scrollY)
           
 void setCtrlKey(boolean val)
           
 int setDynamicValue(String name, Object value, DynEnv env)
          Set field `name' to `value'.
 void setKeyCode(long kc)
           
 void setMetaKey(boolean val)
           
 void setModifiers(int modifiers)
           
 void setMouseButtons(short value)
           
 void setMousePressPopupTrigger(boolean trigger)
           
 void setObjectPainter(ObjectPainter op)
           
 void setPopupTrigger(boolean trigger)
           
 void setPosX(int val)
           
 void setPosY(int val)
           
 void setScreenCoords(int x, int y)
           
 void setShiftKey(boolean val)
           
 
Methods inherited from class ice.pilots.html4.DOMEvent
getBubbles, getCancelable, getCurrentNode, getCurrentTarget, getDDocument, getEventPhase, getSystemEvent, getTarget, getTimeStamp, getType, getTypeId, getViewport, initEvent, isDefaultCancelled, isDefaultDone, preventDefault, setDefaultDone, setSystemEvent, stopPropagation, toString
 
Methods inherited from class ice.storm.DynamicObject
deleteSlot, deleteSlot, getDynamicScopeParent, getEnumeratableIds, getMethodPropertySource, getScriptDataLock, getScriptWrapper, getSlot, getSlot, hasSlot, hasSlot, javaReflectionTarget, readOnlySlots, script_toSource, script_toString, setScriptWrapperIfAbsent, setSlot, setSlot, unlinkAllSlots
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.w3c.dom.events.Event
getBubbles, getCancelable, getCurrentTarget, getEventPhase, getTarget, getTimeStamp, getType, initEvent, preventDefault, stopPropagation
 

Field Detail

BUTTON_NONE

public static final short BUTTON_NONE
See Also:
Constant Field Values

BUTTON_LEFT

public static final short BUTTON_LEFT
See Also:
Constant Field Values

BUTTON_RIGHT

public static final short BUTTON_RIGHT
See Also:
Constant Field Values

BUTTON_LEFT_RIGHT

public static final short BUTTON_LEFT_RIGHT
See Also:
Constant Field Values

BUTTON_MIDDLE

public static final short BUTTON_MIDDLE
See Also:
Constant Field Values

BUTTON_LEFT_MIDDLE

public static final short BUTTON_LEFT_MIDDLE
See Also:
Constant Field Values

BUTTON_RIGHT_MIDDLE

public static final short BUTTON_RIGHT_MIDDLE
See Also:
Constant Field Values

BUTTON_ALL

public static final short BUTTON_ALL
See Also:
Constant Field Values
Method Detail

copyUIDataFrom

protected void copyUIDataFrom(DOMEvent a_source)
Overrides:
copyUIDataFrom in class DOMEvent

getView

public AbstractView getView()
Description copied from interface: UIEvent
The view attribute identifies the AbstractView from which the event was generated.

Specified by:
getView in interface UIEvent

getDetail

public int getDetail()
Description copied from interface: UIEvent
Specifies some detail information about the Event, depending on the type of event.

Specified by:
getDetail in interface UIEvent

getScreenX

public int getScreenX()
Description copied from interface: MouseEvent
The horizontal coordinate at which the event occurred relative to the origin of the screen coordinate system.

Specified by:
getScreenX in interface MouseEvent

getScreenY

public int getScreenY()
Description copied from interface: MouseEvent
The vertical coordinate at which the event occurred relative to the origin of the screen coordinate system.

Specified by:
getScreenY in interface MouseEvent

getClientX

public int getClientX()
Description copied from interface: MouseEvent
The horizontal coordinate at which the event occurred relative to the DOM implementation's client area.

Specified by:
getClientX in interface MouseEvent

getClientY

public int getClientY()
Description copied from interface: MouseEvent
The vertical coordinate at which the event occurred relative to the DOM implementation's client area.

Specified by:
getClientY in interface MouseEvent

getCharCode

public long getCharCode()

getKeyCode

public long getKeyCode()

getCtrlKey

public boolean getCtrlKey()
Description copied from interface: MouseEvent
Used to indicate whether the 'ctrl' key was depressed during the firing of the event.

Specified by:
getCtrlKey in interface MouseEvent

getShiftKey

public boolean getShiftKey()
Description copied from interface: MouseEvent
Used to indicate whether the 'shift' key was depressed during the firing of the event.

Specified by:
getShiftKey in interface MouseEvent

getAltKey

public boolean getAltKey()
Description copied from interface: MouseEvent
Used to indicate whether the 'alt' key was depressed during the firing of the event. On some platforms this key may map to an alternative key name.

Specified by:
getAltKey in interface MouseEvent

getMetaKey

public boolean getMetaKey()
Description copied from interface: MouseEvent
Used to indicate whether the 'meta' key was depressed during the firing of the event. On some platforms this key may map to an alternative key name.

Specified by:
getMetaKey in interface MouseEvent

getModifiers

public int getModifiers()

isShortcutKey

public boolean isShortcutKey()

getButton

public short getButton()
Description copied from interface: MouseEvent
During mouse events caused by the depression or release of a mouse button, button is used to indicate which mouse button changed state. The values for button range from zero to indicate the left button of the mouse, one to indicate the middle button if present, and two to indicate the right button. For mice configured for left handed use in which the button actions are reversed the values are instead read from right to left.

Specified by:
getButton in interface MouseEvent

getMouseButtons

public short getMouseButtons()

getRelatedNode

public Node getRelatedNode()

getRelatedTarget

public EventTarget getRelatedTarget()
Description copied from interface: MouseEvent
Used to identify a secondary EventTarget related to a UI event. Currently this attribute is used with the mouseover event to indicate the EventTarget which the pointing device exited and with the mouseout event to indicate the EventTarget which the pointing device entered.

Specified by:
getRelatedTarget in interface MouseEvent

initUIEvent

public void initUIEvent(String typeArg,
                        boolean canBubbleArg,
                        boolean cancelableArg,
                        AbstractView viewArg,
                        int detailArg)
Description copied from interface: UIEvent
The initUIEvent method is used to initialize the value of a UIEvent created through the DocumentEvent interface. This method may only be called before the UIEvent has been dispatched via the dispatchEvent method, though it may be called multiple times during that phase if necessary. If called multiple times, the final invocation takes precedence.

Specified by:
initUIEvent in interface UIEvent

initMouseEvent

public void initMouseEvent(String typeArg,
                           boolean canBubbleArg,
                           boolean cancelableArg,
                           AbstractView viewArg,
                           int detailArg,
                           int screenXArg,
                           int screenYArg,
                           int clientXArg,
                           int clientYArg,
                           boolean ctrlKeyArg,
                           boolean altKeyArg,
                           boolean shiftKeyArg,
                           boolean metaKeyArg,
                           short buttonArg,
                           EventTarget relatedTargetArg)
Description copied from interface: MouseEvent
The initMouseEvent method is used to initialize the value of a MouseEvent created through the DocumentEvent interface. This method may only be called before the MouseEvent has been dispatched via the dispatchEvent method, though it may be called multiple times during that phase if necessary. If called multiple times, the final invocation takes precedence.

Specified by:
initMouseEvent in interface MouseEvent

setClientCoords

public void setClientCoords(int new_x,
                            int new_y,
                            int new_scrollX,
                            int new_scrollY)

setScreenCoords

public void setScreenCoords(int x,
                            int y)

setKeyCode

public void setKeyCode(long kc)

setCharCode

public void setCharCode(long cc)

setAltKey

public void setAltKey(boolean val)

setCtrlKey

public void setCtrlKey(boolean val)

setShiftKey

public void setShiftKey(boolean val)

setMetaKey

public void setMetaKey(boolean val)

setModifiers

public void setModifiers(int modifiers)

setButton

public void setButton(short value)

setMouseButtons

public void setMouseButtons(short value)

isPopupTrigger

public boolean isPopupTrigger()

isMousePressPopupTrigger

public boolean isMousePressPopupTrigger()

getPosX

public int getPosX()

getPosY

public int getPosY()

getScrollX

public int getScrollX()

getScrollY

public int getScrollY()

setPopupTrigger

public void setPopupTrigger(boolean trigger)

setMousePressPopupTrigger

public void setMousePressPopupTrigger(boolean trigger)

setPosX

public void setPosX(int val)

setPosY

public void setPosY(int val)

setObjectPainter

public void setObjectPainter(ObjectPainter op)

getObjectPainter

public ObjectPainter getObjectPainter()

getDynamicValue

public Object getDynamicValue(String name,
                              DynEnv env)
Description copied from class: DynamicObject
Returns the `key' field or Defs.NOT_FOUND if `name' does not exist. Returns `FUNCTION_MARK' if `name' represent a function that can be invoke via execDynamicMethod. Note that returned `null' indicates that value is present but set to null.

Overrides:
getDynamicValue in class DOMEvent

setDynamicValue

public int setDynamicValue(String name,
                           Object value,
                           DynEnv env)
Description copied from class: DynamicObject
Set field `name' to `value'. Use `env' to unwrap `value' to a particular type or store it as is

Overrides:
setDynamicValue in class DOMEvent

execDynamicMethod

public Object execDynamicMethod(String name,
                                Object[] args,
                                DynEnv env)
Description copied from class: DynamicObject
Perform function-like actions for `name' with the given args. Returns the result or Defs.NOT_FOUND if name is not associated with function action. Should return result of env.wrapVoid() to indicate method without return value. Use `env' to unwrap `args' elements to a particular type.

Overrides:
execDynamicMethod in class DOMEvent