Overview
Package
Class
Use
Tree
Deprecated
Index
All Classes
Help
Prev Class
Next Class
Sample
Document
Class java.awt.EventQueue
Inherited members: ShowHide
Deprecated: ShowHide
View: ClientSubclassPackageImplementation
java.awt

Class EventQueue

  • java.lang.Object
    • java.awt.EventQueue
  • public class EventQueue extends java.lang.Object
    EventQueue is a platform-independent class that queues events, both from the underlying peer classes and from trusted application classes.

    It encapsulates asynchronous event dispatch machinery which extracts events from the queue and dispatches them by calling dispatchEvent(AWTEvent) method on this EventQueue with the event to be dispatched as an argument. The particular behavior of this machinery is implementation-dependent. The only requirements are that events which were actually enqueued to this queue (note that events being posted to the EventQueue can be coalesced) are dispatched:

    Sequentially.
    That is, it is not permitted that several events from this queue are dispatched simultaneously.
    In the same order as they are enqueued.
    That is, if AWTEvent A is enqueued to the EventQueue before AWTEvent B then event B will not be dispatched before event A.

    Some browsers partition applets in different code bases into separate contexts, and establish walls between these contexts. In such a scenario, there will be one EventQueue per context. Other browsers place all applets into the same context, implying that there will be only a single, global EventQueue for all applets. This behavior is implementation-dependent. Consult your browser's documentation for more information.

    For information on the threading issues of the event dispatch machinery, see AWT Threading Issues.

    Since:
    1.1
    • Static Methods 
      Modifier and Type Static Method and Description
      Ordinary member indicator getCurrentEvent Reveal DetailHide Detail
      static AWTEvent getCurrentEvent()
      Returns the the event currently being dispatched by the EventQueue associated with the calling thread.
      public static AWTEvent getCurrentEvent()
      Returns the the event currently being dispatched by the EventQueue associated with the calling thread. This is useful if a method needs access to the event, but was not designed to receive a reference to it as an argument. Note that this method should only be invoked from an application's event dispatching thread. If this method is invoked from another thread, null will be returned.
      Returns:
      the event currently being dispatched, or null if this method is invoked on a thread other than an event dispatching thread
      Since:
      1.4
      Ordinary member indicator getMostRecentEventTime Reveal DetailHide Detail
      static long getMostRecentEventTime()
      Returns the timestamp of the most recent event that had a timestamp, and that was dispatched from the EventQueue associated with the calling thread.
      public static long getMostRecentEventTime()
      Returns the timestamp of the most recent event that had a timestamp, and that was dispatched from the EventQueue associated with the calling thread. If an event with a timestamp is currently being dispatched, its timestamp will be returned. If no events have yet been dispatched, the EventQueue's initialization time will be returned instead.In the current version of the JDK, only InputEvents, ActionEvents, and InvocationEvents have timestamps; however, future versions of the JDK may add timestamps to additional event types. Note that this method should only be invoked from an application's event dispatching thread. If this method is invoked from another thread, the current system time (as reported by System.currentTimeMillis()) will be returned instead.
      Returns:
      the timestamp of the last InputEvent, ActionEvent, or InvocationEvent to be dispatched, or System.currentTimeMillis() if this method is invoked on a thread other than an event dispatching thread
      Since:
      1.4
      See Also:
      InputEvent.getWhen(), ActionEvent.getWhen(), InvocationEvent.getWhen(), isDispatchThread()
      Ordinary member indicator invokeAndWait Reveal DetailHide Detail
      static void invokeAndWait(java.lang.Runnable runnable)
      Causes runnable to have its run method called in the dispatch thread of the system EventQueue.
      public static void invokeAndWait(java.lang.Runnable runnable) throws java.lang.InterruptedException, java.lang.reflect.InvocationTargetException
      Causes runnable to have its run method called in the dispatch thread of the system EventQueue. This will happen after all pending events are processed. The call blocks until this has happened. This method will throw an Error if called from the event dispatcher thread.
      Parameters:
      runnable - the Runnable whose run method should be executed synchronously in the event dispatch thread of the system EventQueue
      Throws:
      java.lang.InterruptedException - if any thread has interrupted this thread
      java.lang.reflect.InvocationTargetException - if an throwable is thrown when running runnable
      Since:
      1.2
      See Also:
      invokeLater(java.lang.Runnable), Toolkit.getSystemEventQueue(), isDispatchThread()
      Ordinary member indicator invokeLater Reveal DetailHide Detail
      static void invokeLater(java.lang.Runnable runnable)
      Causes runnable to have its run method called in the dispatch thread of the system EventQueue.
      public static void invokeLater(java.lang.Runnable runnable)
      Causes runnable to have its run method called in the dispatch thread of the system EventQueue. This will happen after all pending events are processed.
      Parameters:
      runnable - the Runnable whose run method should be executed asynchronously in the event dispatch thread of the system EventQueue
      Since:
      1.2
      See Also:
      invokeAndWait(java.lang.Runnable), Toolkit.getSystemEventQueue(), isDispatchThread()
      Ordinary member indicator isDispatchThread Reveal DetailHide Detail
      static boolean isDispatchThread()
      Returns true if the calling thread is the current AWT EventQueue's dispatch thread.
      public static boolean isDispatchThread()
      Returns true if the calling thread is the current AWT EventQueue's dispatch thread. Use this method to ensure that a particular task is being executed (or not being) there.

      Note: use the invokeLater(java.lang.Runnable) or invokeAndWait(java.lang.Runnable) methods to execute a task in the current AWT EventQueue's dispatch thread.

      Returns:
      true if running in the current AWT EventQueue's dispatch thread
      Since:
      1.2
      See Also:
      invokeLater(java.lang.Runnable), invokeAndWait(java.lang.Runnable), Toolkit.getSystemEventQueue()
    • Constructors 
      Constructor and Description
      Ordinary member indicator EventQueue Reveal DetailHide Detail
      EventQueue()
       
      public EventQueue()
    • Methods 
      Modifier and Type Method and Description
      Ordinary member indicator createSecondaryLoop Reveal DetailHide Detail
      SecondaryLoop createSecondaryLoop()
      Creates a new secondary loop associated with this event queue.
      public SecondaryLoop createSecondaryLoop()
      Creates a new secondary loop associated with this event queue. Use the SecondaryLoop.enter() and SecondaryLoop.exit() methods to start and stop the event loop and dispatch the events from this queue.
      Returns:
      secondaryLoop A new secondary loop object, which can be used to launch a new nested event loop and dispatch events from this queue
      Since:
      1.7
      See Also:
      SecondaryLoop.enter(), SecondaryLoop.exit()
      Ordinary member indicator dispatchEvent Reveal DetailHide Detail
      protected void dispatchEvent(AWTEvent event)
      Dispatches an event.
      protected void dispatchEvent(AWTEvent event)
      Dispatches an event. The manner in which the event is dispatched depends upon the type of the event and the type of the event's source object:

      Event Type Source Type Dispatched To
      ActiveEvent Any event.dispatch()
      Other Component source.dispatchEvent(AWTEvent)
      Other MenuComponent source.dispatchEvent(AWTEvent)
      Other Other No action (ignored)

      Parameters:
      event - an instance of java.awt.AWTEvent, or a subclass of it
      Throws:
      java.lang.NullPointerException - if event is null
      Since:
      1.2
      Ordinary member indicator getNextEvent Reveal DetailHide Detail
      AWTEvent getNextEvent()
      Removes an event from the EventQueue and returns it.
      public AWTEvent getNextEvent() throws java.lang.InterruptedException
      Removes an event from the EventQueue and returns it. This method will block until an event has been posted by another thread.
      Returns:
      the next AWTEvent
      Throws:
      java.lang.InterruptedException - if any thread has interrupted this thread
      Ordinary member indicator peekEvent Reveal DetailHide Detail
      AWTEvent peekEvent()
      Returns the first event on the EventQueue without removing it.
      public AWTEvent peekEvent()
      Returns the first event on the EventQueue without removing it.
      Returns:
      the first event
      Ordinary member indicator peekEvent Reveal DetailHide Detail
      AWTEvent peekEvent(int id)
      Returns the first event with the specified id, if any.
      public AWTEvent peekEvent(int id)
      Returns the first event with the specified id, if any.
      Parameters:
      id - the id of the type of event desired
      Returns:
      the first event of the specified id or null if there is no such event
      Ordinary member indicator pop Reveal DetailHide Detail
      protected void pop()
      Stops dispatching events using this EventQueue.
      protected void pop() throws java.util.EmptyStackException
      Stops dispatching events using this EventQueue. Any pending events are transferred to the previous EventQueue for processing.

      Warning: To avoid deadlock, do not declare this method synchronized in a subclass.

      Throws:
      java.util.EmptyStackException - if no previous push was made on this EventQueue
      Since:
      1.2
      See Also:
      push(java.awt.EventQueue)
      Ordinary member indicator postEvent Reveal DetailHide Detail
      void postEvent(AWTEvent theEvent)
      Posts a 1.1-style event to the EventQueue.
      public void postEvent(AWTEvent theEvent)
      Posts a 1.1-style event to the EventQueue. If there is an existing event on the queue with the same ID and event source, the source Component's coalesceEvents method will be called.
      Parameters:
      theEvent - an instance of java.awt.AWTEvent, or a subclass of it
      Throws:
      java.lang.NullPointerException - if theEvent is null
      Ordinary member indicator push Reveal DetailHide Detail
      void push(EventQueue newEventQueue)
      Replaces the existing EventQueue with the specified one.
      public void push(EventQueue newEventQueue)
      Replaces the existing EventQueue with the specified one. Any pending events are transferred to the new EventQueue for processing by it.
      Parameters:
      newEventQueue - an EventQueue (or subclass thereof) instance to be use
      Throws:
      java.lang.NullPointerException - if newEventQueue is null
      Since:
      1.2
      See Also:
      pop()
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
This document was created by Dulcet from the OpenJDK sources. Copyright © 1993, 2012 Oracle and/or its affiliates. All rights reserved.

SourceForge