- java.lang.Object
-
- java.awt.EventQueue
-
public class EventQueue extends 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 thisEventQueue
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 theEventQueue
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 theEventQueue
beforeAWTEvent
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, globalEventQueue
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
-
-
Constructor Summary
Constructors Constructor and Description EventQueue()
-
Method Summary
Methods Modifier and Type Method and Description SecondaryLoop
createSecondaryLoop()
Creates a newsecondary loop
associated with this event queue.protected void
dispatchEvent(AWTEvent event)
Dispatches an event.static AWTEvent
getCurrentEvent()
Returns the the event currently being dispatched by theEventQueue
associated with the calling thread.static long
getMostRecentEventTime()
Returns the timestamp of the most recent event that had a timestamp, and that was dispatched from theEventQueue
associated with the calling thread.AWTEvent
getNextEvent()
Removes an event from theEventQueue
and returns it.static void
invokeAndWait(Runnable runnable)
static void
invokeLater(Runnable runnable)
static boolean
isDispatchThread()
Returns true if the calling thread isthe current AWT EventQueue
's dispatch thread.AWTEvent
peekEvent()
Returns the first event on theEventQueue
without removing it.AWTEvent
peekEvent(int id)
Returns the first event with the specified id, if any.protected void
pop()
Stops dispatching events using thisEventQueue
.void
postEvent(AWTEvent theEvent)
Posts a 1.1-style event to theEventQueue
.void
push(EventQueue newEventQueue)
Replaces the existingEventQueue
with the specified one.
-
-
-
Method Detail
-
postEvent
public void postEvent(AWTEvent theEvent)
Posts a 1.1-style event to theEventQueue
. If there is an existing event on the queue with the same ID and event source, the sourceComponent
'scoalesceEvents
method will be called.- Parameters:
theEvent
- an instance ofjava.awt.AWTEvent
, or a subclass of it- Throws:
NullPointerException
- iftheEvent
isnull
-
getNextEvent
public AWTEvent getNextEvent() throws InterruptedException
Removes an event from theEventQueue
and returns it. This method will block until an event has been posted by another thread.- Returns:
- the next
AWTEvent
- Throws:
InterruptedException
- if any thread has interrupted this thread
-
peekEvent
public AWTEvent peekEvent()
Returns the first event on theEventQueue
without removing it.- Returns:
- the first event
-
peekEvent
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
-
dispatchEvent
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 ofjava.awt.AWTEvent
, or a subclass of it- Throws:
NullPointerException
- ifevent
isnull
- Since:
- 1.2
-
getMostRecentEventTime
public static long getMostRecentEventTime()
Returns the timestamp of the most recent event that had a timestamp, and that was dispatched from theEventQueue
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, onlyInputEvent
s,ActionEvent
s, andInvocationEvent
s 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'sevent dispatching thread
. If this method is invoked from another thread, the current system time (as reported bySystem.currentTimeMillis()
) will be returned instead.- Returns:
- the timestamp of the last
InputEvent
,ActionEvent
, orInvocationEvent
to be dispatched, orSystem.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()
-
getCurrentEvent
public static AWTEvent getCurrentEvent()
Returns the the event currently being dispatched by theEventQueue
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
-
push
public void push(EventQueue newEventQueue)
Replaces the existingEventQueue
with the specified one. Any pending events are transferred to the newEventQueue
for processing by it.- Parameters:
newEventQueue
- anEventQueue
(or subclass thereof) instance to be use- Throws:
NullPointerException
- ifnewEventQueue
isnull
- Since:
- 1.2
- See Also:
pop()
-
pop
protected void pop() throws EmptyStackException
Stops dispatching events using thisEventQueue
. Any pending events are transferred to the previousEventQueue
for processing.Warning: To avoid deadlock, do not declare this method synchronized in a subclass.
- Throws:
EmptyStackException
- if no previous push was made on thisEventQueue
- Since:
- 1.2
- See Also:
push(java.awt.EventQueue)
-
createSecondaryLoop
public SecondaryLoop createSecondaryLoop()
Creates a newsecondary loop
associated with this event queue. Use theSecondaryLoop.enter()
andSecondaryLoop.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()
-
isDispatchThread
public static boolean isDispatchThread()
Returns true if the calling thread isthe 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)
orinvokeAndWait(java.lang.Runnable)
methods to execute a task inthe 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()
-
invokeLater
public static void invokeLater(Runnable runnable)
Causesrunnable
to have itsrun
method called in thedispatch thread
ofthe system EventQueue
. This will happen after all pending events are processed.- Parameters:
runnable
- theRunnable
whoserun
method should be executed asynchronously in theevent dispatch thread
ofthe system EventQueue
- Since:
- 1.2
- See Also:
invokeAndWait(java.lang.Runnable)
,Toolkit.getSystemEventQueue()
,isDispatchThread()
-
invokeAndWait
public static void invokeAndWait(Runnable runnable) throws InterruptedException, InvocationTargetException
Causesrunnable
to have itsrun
method called in thedispatch thread
ofthe 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 theevent dispatcher thread
.- Parameters:
runnable
- theRunnable
whoserun
method should be executed synchronously in theevent dispatch thread
ofthe system EventQueue
- Throws:
InterruptedException
- if any thread has interrupted this threadInvocationTargetException
- if an throwable is thrown when runningrunnable
- Since:
- 1.2
- See Also:
invokeLater(java.lang.Runnable)
,Toolkit.getSystemEventQueue()
,isDispatchThread()
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
22/12/2024 11:30:27 Cette version de la page est en cache (à la date du 22/12/2024 11:30:27) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 30/08/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-java/awt/eventqueue.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.