|
RSE Release 3.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRSEInteractionProvider
Interaction Provider Interface. Classes implementing this interface provide a means for RSE to communicate with the outside world: via progress monitors, events and messages. A UI implementation of this interface would typically use UI components for user interaction; although this can be changed also intermittently. Non-UI headless applications may log messages rather than doing interactive messages, and may use different Threads for sending messages.
EXPERIMENTAL. This class or interface has been added as part of a work in progress. There is no guarantee that this API will work or that it will remain the same. Please do not use this API without consulting with the Target Management team.
Method Summary | |
---|---|
void |
asyncExec(Runnable runnable)
Asynchronously run the given runnable in a separate thread. |
void |
eventExec(Runnable runnable)
Run the given runnable with "event" semantics, that is: asynchronously run it through asyncExec(Runnable) on the interaction provider's
designated event thread, unless the call is already coming from that very
thread. |
void |
flushRunnableQueue()
Flush the Queue of Runnables enqueued with asyncExec(Runnable) . |
IProgressMonitor |
getDefaultProgressMonitor()
Return a default progress monitor for the context that's currently active. |
void |
runInDefaultContext(boolean fork,
boolean cancellable,
IRSERunnableWithProgress runnable)
Runs the given IRSERunnableWithProgress in the default
context available to this interaction provider, that provides a progress
monitor. |
void |
showMessage(SystemMessage msg)
Show the given message or log it. |
Method Detail |
---|
IProgressMonitor getDefaultProgressMonitor()
void runInDefaultContext(boolean fork, boolean cancellable, IRSERunnableWithProgress runnable) throws InvocationTargetException, InterruptedException
Runs the given IRSERunnableWithProgress
in the default
context available to this interaction provider, that provides a progress
monitor. For example, if the default context is a
ProgressMonitorDialog
then the runnable is run using the
dialog's progress monitor. This method is derived from
IRunnableContext#run()
.
If fork
is false
, the current thread is
used to run the runnable. Note that if fork
is
true
, it is unspecified whether or not this method blocks
until the runnable has been run. Implementers should document whether the
runnable is run synchronously (blocking) or asynchronously
(non-blocking), or if no assumption can be made about the blocking
behaviour.
fork
- true
if the runnable should be run in a
separate thread, and false
to run in the same
threadcancellable
- true
to enable the cancellation, and
false
to make the operation uncancellablerunnable
- the runnable to run
InvocationTargetException
- wraps any exception or error which
occurs while running the runnable
InterruptedException
- propagated by the context if the runnable
acknowledges cancellation by throwing this exception. This
should not be thrown if cancellable is false
.void asyncExec(Runnable runnable)
runnable
- the Runnable to run asynchronouslyvoid eventExec(Runnable runnable)
asyncExec(Runnable)
on the interaction provider's
designated event thread, unless the call is already coming from that very
thread.
In that case, the Runnable is run immediately and synchronously.
runnable
- the Runnable to run asynchronously with "event" semanticsasyncExec(Runnable)
void flushRunnableQueue()
asyncExec(Runnable)
.
This needs to be done when this interaction provider is to be replaced by
a different one, in order to ensure that the ordering of all Runnables
remains intact.
void showMessage(SystemMessage msg)
msg
- the message to show
|
RSE Release 3.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |