Search code examples
eclipse-plugine4

Trigger evaluation of PropertyTester


The code from two years back had to be upgraded to E4, and now a bunch of stuff does not work anymore. One of these is the IEvaluationService if used like this:

<handler class="org.acme.PrintHandler" commandId="org.eclipse.ui.file.print">
  <activeWhen>
    <with variable="activePart">
      <test property="org.acme.printable" />
    </with>
  </activeWhen>
</handler>
IEvaluationService service = (IEvaluationService) PlatformUI.getWorkbench().getService(IEvaluationService.class);
service.requestEvaluation("org.acme.printable");

How do I (re)trigger the evaluation of a PropertyTester? Since E4 is really not even close to being production ready, I need a workaround for E3 (compatibility layer).

Related question - but this user was searching for the equivalent in E4, while I need one that works in E3.

Funnily enough, if I replace the <activeWhen> tags with <enabledWhen> it works. In that case IEventBroker#post and IEventBroker#send work, too.

This is a similar question. That user used Eclipse 4.2 - I tested the problem with 4.5, 4.6 and 4.7.


Solution

  • The EvaluationService is API compatible in the E3 Compatibility Layer. But the implementation in E4 is completely different, causing the behaviour of requestEvaluation to be fundamentally different.

    The best solution to this problem I could find is to manually deactivate and activate all contexts of currently active parts. This causes internally to re-evaluate and, when required, re-render all UI elements of the respective parts.

    One could argue this is less efficient than requesting the evaluation of a very specific property, as the EvaluationService is supposed to do. But since the evaluation is limited to active parts only, it should not create too much overhead. And it does work globally, as no specific property string is required anymore.

    The only usecase not covered by this yet may be the main toolbar of your RCP application.

    /**
     * Triggers evaluation of all UI elements (buttons, etc.) of the active part.
     * Also causes test of all property testers of all opened parts implicitly.
     * Workaround of the broken <code>IEvaluationService.requestEvaluation</code>.
     */
    public static void triggerUIElementsEvaluation() {
        try {
            final EPartService partService = PlatformUI.getWorkbench().getService(EPartService.class);
            final MPart activePart = partService.getActivePart();
    
            /* Toggle context of active part to trigger re-evaluation of its UI elements. */
            if (activePart != null) {
                activePart.getContext().deactivate();
                activePart.getContext().activateBranch();
            }
        } catch (IllegalStateException e) {
            /* Ignore "Application does not have an active window" exception to allow program to continue. */
        }
    }