Bug 331535

Comment 1 Matthias Zimmermann 2011-04-05 07:41:08 EDT

ref at BSI #100433

Comment 2 Matthias Zimmermann 2011-05-05 02:26:51 EDT

26.4.11  imotsch

Details:
Evaluated various solution variants:
1) service: not quite flexible since osgi services are either global or scoped on scout sessions. However, also gui composites are using ScoutTexts.get(...)
2) extension point: not valid. since this would merge texts of all scout apps in same workbench together
3) texts attached to client/server session: good starting point since swing/swt environment knows session.

3) is the solution. 
The session-scoped nls texts (Texts.java) is set as ClientJob/ServerJob.setProperty() value on the Job and is then accessible via currentJob. ScoutTexts is delegating to this scope texts (default to ScoutTexts self)
ClientSession and ServerSession can override getNlsTexts() method to return their specific Texts.getInstance() object.
Swing is using the client session texts globally, swt / rwt is using the client session texts via Display.getData() accessor.

Migration: optionally add the following overrides to the client and server session of the application to support for 
partially overriding existing scout texts

public class ClientSession 
...
  @Override
  public DynamicNls getNlsTexts() {
    return Texts.getInstance();
  }


public class ServerSession 
...
  @Override
  public DynamicNls getNlsTexts() {
    return Texts.getInstance();
  }

Comment 3 Matthias Zimmermann 2011-05-05 02:28:49 EDT

4.5.2011 lhuser:

Tested on Scout Trunk with Swing Gui. NOT tested with SWT Gui.

The following test cases are OK:
- Overwrite texts for ScoutTexts.get() in custom Form: OK
- Overwrite texts for ScoutTexts.get() in Scout components (e.g. AbstractSearchButton): OK
- Overwrite texts for SwingUtlity.getNlsText() in Swing components (e.g. StatusBar->Network Latency): OK
- NOT tested for SWT components!

The following test case is NOK:
- Overwrite texts in the Calendar (e.g. link 'Month').
Some texts are set as UI defaults (interceptUIDefaults() in AbstractSwingEnvironment calls UIDefaultsInjector.inject(), which queries texts with ScoutTexts.get()). The SwingEnvironment is created in the constructor of the AbstractSwingApplication. The ClientSession is created afterwards (during the start() Method of AbstractSwingApplication).

Possible solution(?): call interceptUIDefaults() after the ClientSession has been created in Method AbstractSwingApplication.startInSubject().

Comment 4 Ivan Motsch 2011-05-05 11:42:23 EDT

Since this applies to swing ui, you can simply override SwingApplication.createSwingEnvironment() in your project as:

  @Override
  protected ISwingEnvironment createSwingEnvironment() {
    SwingUtility.setNlsTexts(Texts.getInstance());
    return super.createSwingEnvironment();
  }

Comment 5 Lukas Huser 2011-05-06 06:28:35 EDT

This will not resolve the issue, because UIDefaultsInjector.inject() does not invoke the SwingUtility for texts but calls ScoutTexts.get(). ScoutTexts.get() then queries the current Job for an instance of DynamicNls. At this point, the current Job will not deliver a DynamicNls instance (because a ClientSession has not been created yet).

Comment 6 Lukas Huser 2011-05-09 10:20:08 EDT

Successfully tested on Scout Trunk after another update by Ivan Motsch.

Comment 7 Matthias Zimmermann 2011-06-28 08:02:19 EDT

shipped with eclipse scout 3.7.0