system.util.invokeLater question

[lrose]

@bkarabinchak.psi

Basically it just delays when your function will be run on the GUI thread. So if you have some function foo() that runs on window startup and you call it with system.util.invokeLater(foo, 1000) in the windowOpened extension function, then 1000 ms after the window opens, it will try to run foo.

The reason the documentation says This is useful for events like propertyChange events, where the script is called before any bindings are evaluated. is that for certain propertyChange events, you probably don’t want to run them on the initial change/where the property is empty or not evaluated yet. So you tell your property change event to wait a little before executing to ensure you have data to work with.

This is true, but not quite all the information. I would say, IMHO, you've left out the most important reason for the function.

invokeLater() waits until all of the processing and pending events on the event dispatch thread ('commonly referred to as the GUI thread) are done being processed, then invokes the supplied function on the GUI thread.

This leads to two important uses of the function

1. As described it is useful for propertyChange events where you want to wait for the bindings to be evaluated.

2. In an asynchronous thread this function is used to move any UI interaction back to the Event Dispatch Thread.

@bkarabinchak.psi

As for using it without any ms parameter, as in system.util.invokeLater(foo) , I don’t know how that works under the hood and would like to hear from someone the logic that this sort of call follows.

If the delay parameter is supplied, then the supplied function will be invoked after all currently pending events are processed plus the delay, if no delay parameter is supplied then the function is invoked immediately after all currently pending events are processed.

@lachguerabdallah

I am using it in all my propertyChange scripts. is it good practice?

I'm not sure I would label it as good or bad practice, only 'probably unneeded'.

Here is a good post on the topic, it's a little dated but still very applicable.

Loading bar during script execution

In general, any script in a GUI should run in < 0.1 second unless it’s put in the background. system.util.invokeAsynchronous() is the tool you need to kick off your script. However, from the background, it isn’t safe to interact with the UI at all (Like, lock up or crash the whole client). So your script must collect it’s results and pass them to a script called from system.util.invokeLater(), which will run in the GUI thread and can place your results into the target components. For a progre…