Save This Page
Home » openjdk-7 » java » awt » event » [javadoc | source]
java.awt.event
abstract public class: InputEvent [javadoc | source]
java.lang.Object
   java.util.EventObject
      java.awt.AWTEvent
         java.awt.event.ComponentEvent
            java.awt.event.InputEvent

All Implemented Interfaces:
    Serializable

Direct Known Subclasses:
    MenuDragMouseEvent, MouseWheelEvent, MenuKeyEvent, MouseEvent, KeyEvent

The root event class for all component-level input events. Input events are delivered to listeners before they are processed normally by the source where they originated. This allows listeners and component subclasses to "consume" the event so that the source will not process them in their default manner. For example, consuming mousePressed events on a Button component will prevent the Button from being activated.
Field Summary
public static final  int SHIFT_MASK    The Shift key modifier constant. It is recommended that SHIFT_DOWN_MASK be used instead. 
public static final  int CTRL_MASK    The Control key modifier constant. It is recommended that CTRL_DOWN_MASK be used instead. 
public static final  int META_MASK    The Meta key modifier constant. It is recommended that META_DOWN_MASK be used instead. 
public static final  int ALT_MASK    The Alt key modifier constant. It is recommended that ALT_DOWN_MASK be used instead. 
public static final  int ALT_GRAPH_MASK    The AltGraph key modifier constant. 
public static final  int BUTTON1_MASK    The Mouse Button1 modifier constant. It is recommended that BUTTON1_DOWN_MASK be used instead. 
public static final  int BUTTON2_MASK    The Mouse Button2 modifier constant. It is recommended that BUTTON2_DOWN_MASK be used instead. Note that BUTTON2_MASK has the same value as ALT_MASK. 
public static final  int BUTTON3_MASK    The Mouse Button3 modifier constant. It is recommended that BUTTON3_DOWN_MASK be used instead. Note that BUTTON3_MASK has the same value as META_MASK. 
public static final  int SHIFT_DOWN_MASK    The Shift key extended modifier constant.
    since: 1.4 -
 
public static final  int CTRL_DOWN_MASK    The Control key extended modifier constant.
    since: 1.4 -
 
public static final  int META_DOWN_MASK    The Meta key extended modifier constant.
    since: 1.4 -
 
public static final  int ALT_DOWN_MASK    The Alt key extended modifier constant.
    since: 1.4 -
 
public static final  int BUTTON1_DOWN_MASK    The Mouse Button1 extended modifier constant.
    since: 1.4 -
 
public static final  int BUTTON2_DOWN_MASK    The Mouse Button2 extended modifier constant.
    since: 1.4 -
 
public static final  int BUTTON3_DOWN_MASK    The Mouse Button3 extended modifier constant.
    since: 1.4 -
 
public static final  int ALT_GRAPH_DOWN_MASK    The AltGraph key extended modifier constant.
    since: 1.4 -
 
static final  int FIRST_HIGH_BIT     
static final  int JDK_1_3_MODIFIERS     
static final  int HIGH_MODIFIERS     
 long when    The input event's Time stamp in UTC format. The time stamp indicates when the input event was created. 
 int modifiers    The state of the modifier mask at the time the input event was fired. 
static final  long serialVersionUID     
Fields inherited from java.awt.event.ComponentEvent:
COMPONENT_FIRST,  COMPONENT_LAST,  COMPONENT_MOVED,  COMPONENT_RESIZED,  COMPONENT_SHOWN,  COMPONENT_HIDDEN
Fields inherited from java.awt.AWTEvent:
id,  consumed,  focusManagerIsDispatching,  isPosted,  COMPONENT_EVENT_MASK,  CONTAINER_EVENT_MASK,  FOCUS_EVENT_MASK,  KEY_EVENT_MASK,  MOUSE_EVENT_MASK,  MOUSE_MOTION_EVENT_MASK,  WINDOW_EVENT_MASK,  ACTION_EVENT_MASK,  ADJUSTMENT_EVENT_MASK,  ITEM_EVENT_MASK,  TEXT_EVENT_MASK,  INPUT_METHOD_EVENT_MASK,  INPUT_METHODS_ENABLED_MASK,  PAINT_EVENT_MASK,  INVOCATION_EVENT_MASK,  HIERARCHY_EVENT_MASK,  HIERARCHY_BOUNDS_EVENT_MASK,  MOUSE_WHEEL_EVENT_MASK,  WINDOW_STATE_EVENT_MASK,  WINDOW_FOCUS_EVENT_MASK,  RESERVED_ID_MAX
Fields inherited from java.util.EventObject:
source
Constructor:
 InputEvent(Component source,
    int id,
    long when,
    int modifiers) 
    Constructs an InputEvent object with the specified source component, modifiers, and type.

    This method throws an IllegalArgumentException if source is null.

    Parameters:
    source - the object where the event originated
    id - the integer that identifies the event type. It is allowed to pass as parameter any value that allowed for some subclass of {@code InputEvent} class. Passing in the value different from those values result in unspecified behavior
    when - a long int that gives the time the event occurred. Passing negative or zero value is not recommended
    modifiers - the modifier keys down during event (e.g. shift, ctrl, alt, meta) Passing negative parameter is not recommended. Zero value means no modifiers. Either extended _DOWN_MASK or old _MASK modifiers should be used, but both models should not be mixed in one event. Use of the extended modifiers is preferred
    Throws:
    IllegalArgumentException - if source is null
    Also see:
    getSource()
    getID()
    getWhen()
    getModifiers()
Method from java.awt.event.InputEvent Summary:
consume,   getMaskForButton,   getModifiers,   getModifiersEx,   getModifiersExText,   getWhen,   isAltDown,   isAltGraphDown,   isConsumed,   isControlDown,   isMetaDown,   isShiftDown
Methods from java.awt.event.ComponentEvent:
getComponent,   paramString
Methods from java.awt.AWTEvent:
consume,   convertToOld,   copyPrivateDataInto,   dispatched,   getAccessControlContext,   getID,   isConsumed,   paramString,   setSource,   toString
Methods from java.util.EventObject:
getSource,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.awt.event.InputEvent Detail:
 public  void consume() 
    Consumes this event so that it will not be processed in the default manner by the source which originated it.
 public static int getMaskForButton(int button) 
 public int getModifiers() 
    Returns the modifier mask for this event.
 public int getModifiersEx() 
    Returns the extended modifier mask for this event. Extended modifiers represent the state of all modal keys, such as ALT, CTRL, META, and the mouse buttons just after the event occurred

    For example, if the user presses button 1 followed by button 2, and then releases them in the same order, the following sequence of events is generated:

       MOUSE_PRESSED:  BUTTON1_DOWN_MASK
       MOUSE_PRESSED:  BUTTON1_DOWN_MASK | BUTTON2_DOWN_MASK
       MOUSE_RELEASED: BUTTON2_DOWN_MASK
       MOUSE_CLICKED:  BUTTON2_DOWN_MASK
       MOUSE_RELEASED:
       MOUSE_CLICKED:
    

    It is not recommended to compare the return value of this method using == because new modifiers can be added in the future. For example, the appropriate way to check that SHIFT and BUTTON1 are down, but CTRL is up is demonstrated by the following code:

       int onmask = SHIFT_DOWN_MASK | BUTTON1_DOWN_MASK;
       int offmask = CTRL_DOWN_MASK;
       if ((event.getModifiersEx() & (onmask | offmask)) == onmask) {
           ...
       }
    
    The above code will work even if new modifiers are added.
 public static String getModifiersExText(int modifiers) 
    Returns a String describing the extended modifier keys and mouse buttons, such as "Shift", "Button1", or "Ctrl+Shift". These strings can be localized by changing the awt.properties file.

    Note that passing negative parameter is incorrect, and will cause the returning an unspecified string. Zero parameter means that no modifiers were passed and will cause the returning an empty string.

 public long getWhen() 
    Returns the difference in milliseconds between the timestamp of when this event occurred and midnight, January 1, 1970 UTC.
 public boolean isAltDown() 
    Returns whether or not the Alt modifier is down on this event.
 public boolean isAltGraphDown() 
    Returns whether or not the AltGraph modifier is down on this event.
 public boolean isConsumed() 
    Returns whether or not this event has been consumed.
 public boolean isControlDown() 
    Returns whether or not the Control modifier is down on this event.
 public boolean isMetaDown() 
    Returns whether or not the Meta modifier is down on this event.
 public boolean isShiftDown() 
    Returns whether or not the Shift modifier is down on this event.