Eclipse Platform Localization. The Luna Updates. Seite 1. codecentric AG

Size: px

Start display at page:

Download "Eclipse Platform Localization. The Luna Updates. Seite 1. codecentric AG"

Paula Carr
6 years ago
Views:

1 Eclipse Platform Localization The Luna Updates Seite 1

2 SPEAKER Seite 2

3 LOCALIZATION BASICS Properties File (e.g. bundle.properties) application=translation Service Example (OSGi) label_message=my Label... OSGi ResourceBundle Properties file Default location OSGI-INF/l10n Default name = bundle.properties Can be configured in MANIFEST.MF via Bundle- Localization attribute Seite 3

4 LOCALIZABLE RESOURCES - PLUGIN.XML Only OSGi ResourceBundles are supported Keys are specified with a leading % Seite 4

5 LOCALIZABLE RESOURCES - APPLICATION MODEL Translated via TranslationService Default uses OSGi ResourceBundle Keys are specified with a leading % Seite 5

6 LOCALIZABLE RESOURCES - SOURCE CODE String-based ResourceBundle bundle = ResourceBundle.getBundle("..."); String label = bundle.getstring("label_message"); Pros: Usage of plain Java mechanisms Cons: Keys need to be known No code assist No refactoring support Constant-based public class Messages extends NLS { public static String label_message; static { NLS.initializeMessages(BUNDLE, Messages.class); String label = Messages.label_message; Pros: Code Completion Refactoring support Cons: Properties files in package tree Constants are not removed by the Garbage Collector No dot -separator for key hierarchies Seite 6

7 LOCALIZABLE RESOURCES - SOURCE CODE public TranslationTest(TranslationService service) { String label = service.translate( "%label_message", "platform:/plugin/translation")); Pros: Completely customizable translation mechanism Cons: Keys need to be known No code assist No refactoring support Also the plugin that contains the OSGi ResourceBundle needs to be known Seite 7

8 GENERAL DOWNSIDES Multiple properties files for translations OSGi ResourceBundle One properties file set for each Messages class Mixing of Java- and Resource-Files in packages Properties files relative to Message class No Locale-Change-Support at runtime Constants can not change values Seite 8

9 LUNA LOCALIZATION UPDATE New Eclipse Translation Pattern Application Model Update MLocalizable ILocaleChangeService ResourceBundleProvider Seite 9

10 NEW MESSAGE EXTENSION NLS Mechanism public class Messages extends NLS { private static final String BUNDLE_NAME = "..."; public static String my_first_label; public static String my_second_label; static { // initialize resource bundle NLS.initializeMessages(BUNDLE_NAME, Messages.class); //bind values to the placeholders NLS.bind(Messages.my_second_label, "Dirk", "Cool"); private Messages() { New Message public class Messages { public String myfirstlabel; public String public void postconstruct() { mysecondlabel = MessageFormat.format( mysecondlabel, "Dirk", "Cool"); No class hierarchy No constants No static initializer my_first_label=my first label my_second_label={0 says {1 my.first.label=my first label my.second.label={0 says {1 Dot separators supported Seite 10

11 NEW MESSAGE is optional Configure ResourceBundle location via contributionuri OSGi ResourceBundle platform:/[plugin fragment]/[bundle-symbolicname] File-based ResourceBundle platform:/[plugin fragment]/[bundle-symbolicname]/[path]/[basename] Class-based ResourceBundle bundleclass://[plugin fragment]/[fully-qualified-classname] Configure caching behaviour via referencetype ReferenceType.NONE = No caching, every requestor gets its own instance ReferenceType.WEAK = Weak reference, immediatelly eligible for garbage collection if every requestor was garbage collected ReferenceType.SOFT = Soft reference, stays in memory for some time even if every requestor was garbage collected (default) Seite 11

NEW MESSAGE EXTENSION - RESOURCEBUNDLE 1. Check @Message annotation 2.

12 NEW MESSAGE EXTENSION - RESOURCEBUNDLE 1. annotation 2. Check relative located ResourceBundle files 3. Use the ResourceBundleProvider (default OSGi ResourceBundle) Seite 12

13 NEW MESSAGE EXTENSION Simply inject the Messages @Translation private Messages messages;... mylabel.settext(messages.myfirstlabel); Eclipse Translation public void translate(@translation Messages messages) { if (mylabel!= null &&!mylabel.isdisposed()) mylabel.settext(messages.mylabelmessage); Dynamic method injection if Messages instance is updated in context Seite 13

14 APPLICATION MODEL UPDATE IntroducedMLocalizable ILocaleChangeService lcs;... lcs.changeapplicationlocale(input.gettext()); 1. Updates the value fortranslationservice.locale in the application context 2. Triggers update events formlocalizable model elements 3. Fires an private void Locale s) { System.out.println("Injected via event broker: " + s); Seite 14

15 RESOURCEBUNDLEPROVIDER Introduced ResourceBundleProvider OSGi service public interface ResourceBundleProvider { ResourceBundle getresourcebundle(bundle bundle, String locale); Used by TranslationService default implementation and New Message Extension Default implementation loads OSGi ResourceBundles Add ability to customize ResourceBundle loading Exchange the way a ResourceBundle should be loaded in one place Need to be registered before the model gets passed to the renderer public class ResourceBundleAddon void postconstruct(final IEclipseContext context) { context.set(resourcebundleprovider.class, new CustomResourceBundleProvider()); Seite 15

16 MISSING PARTS Registry for UI controls to manage Locale changes automatically AbstractMessageRegistry with Java 8 in e(fx)clipse AbstractMessageRegistry with Java 6 upwards IDE support Externalize Strings Hover effect Update of all Eclipse Platform plugins to use the New Message Extension Seite 16

17 EXAMPLE APPLICATIONS Seite 17

Eclipse 4 Application Platform

Eclipse 4 Application Platform Tom Schindl - BestSolution Systemhaus GmbH EclipseCon Nov 2011 About Tom CEO BestSolution Systemhaus GmbH Eclipse Committer e4 Platform UI EMF Projectlead: UFaceKit, Nebula