Branding & Internationalization with the NetBeans Platform

NetBeans Rich Client Platform

Branding & Internationalisation


Anton Epple
Eppleton IT Consulting


Agenda

Internationalisation
Branding
Accessibility



Internationalisable Resources:
String values in source files
String values in manifest
Help pages
Graphics
Files
Layer.xml ( e.g. Folders)



NbBundle:
Similar to java.util.PropertyResourceBundle
Extends the functionality of the default Java resource
support
Better Integration with Module System (multiple
classloaders)
nbresloc protocol for localized files



Text constants in Source Files:
Special ResourceBundle: NbBundle
Bundle.properties File in package:
CTL_MyTopComponent = My Window
Nachricht_Parameter = This is my {0}. Window

Call from Java:
ResourceBundle bundle = NbBundle.getBundle(MyTopComponent.class);
String msg = bundle.getString(„CTL_MyTopComponent“);
// oder
String msg = NbBundle.getMessage(MyTopComponent.class, „CTL_MyTopComponent“);
// bis zu 3 Einzel Parameter
String msg = NbBundle.getMessage(MyTopComponent.class, „Nachricht_Parameter“,
New Integer(3));



Externalize String Constants to .properties Files
• Tools → Internationalization → Internationalization Wizard



String values in manifests
Manifest file:
Manifest-Version: 1.0
OpenIDE-Module: de.eppleton.language
OpenIDE-Module-Localizing-Bundle: de/eppleton/language/Bundle.properties

Bundle.properties:
OpenIDE-Module-Name=Language Switch

Bundle_de.properties Datei:
OpenIDE-Module-Name=Sprach Wechsel



Search order:
Locale US:
1. Bundle_en_US.properties
2. Bundle_en.properties
3. Bundle.properties



Other Resources:
Help Pages: Attach locale-extension ( _de ) to
resources (html files, etc.)
Load graphics via localised String, or use extension
(icon.gif, icon_de.gif):
Image img = Utilities.loadImage(„resources/icon.gif“, true);

• System FileSystem (Menu):
Folder Attribute
SystemFileSystem.localizingBundle



nbresloc Protocol
Load localized Version of File:
URL u = new URL(„nbresloc:/de/eppleton/netbeans/modules/icon.png“);
ImageIcon icon = newImageIcon(u);

Can load resources from all Modules:
also be used to reduce redundancy e.g.
central repository for icons



Bundling localization resources in Folder „locale“:
Example NetBeans platform9 Modules:



Simplify Localization by externalizing defaults:
Translator sees only localizable resources:



Localisation Bundles as Modules:
Localization can also be packaged as installable
Plugin
User can install Language pack for his Locale:
http://www.sepix.de/blogs/blogrittner/blog/archive/2008/augu
http://blogs.kiyut.com/tonny/2008/08/06/netbeans-platform-lo



OmegaT Translation Tool:
http://sf.net/projects/omegat/
http://translatedfiles.netbeans.org/docs/HOWTOs/How-to-trans



Change language on-the-fly (1): MenuItems
Not officially supported (but useful for Support →
zh_CN)
but most MenuItems react to changing Locale:
public String getName() {
return NbBundle.getMessage(SaveAction.class, "Save");
}

Some don't (SaveAsAction):
AbstractAction instance =
Lookups.forPath("Actions/System").lookup(AbstractAction.class);
instance.putValue(Action.NAME, NbBundle.getMessage(DataObject.class,
"CTL_SaveAsAction"));



Change language on-the-fly (2): Menus
1. Possibility: MenuBar
Frame main = WindowManager.getDefault().getMainWindow();
assert main != null;
if (main instanceof JFrame) {
Component [] c = ((Jframe)main).getJMenuBar().getComponents();
[....](Jmenu)c[i].setText(„internationalisiert...“);
} // Error-prone...



2. Possibility: Force Refresh
FileSystem sfs = Repository.getDefault().getDefaultFileSystem();
FileObject menus = sfs.findResource("Menu");
FileObject[] children = menus.getChildren();
for (int i = 0; i < children.length; i++) {
FileObject fileObject = children[i];
FileLock lock = null;
try {
lock = fileObject.lock();
String oldname= fileObject.getName();
fileObject.rename(lock, File.createTempFile("bla",
"bla").getName(), null);
fileObject.rename(lock, oldname, null);
} catch (FileAlreadyLockedException es) { }
lock.releaseLock();}

Demo


Einfaches Branding einer Anwendung
Properties Dialog:


Basic Branding
Properties Dialog:


Basic Branding

Properties Dialog:


Replacing Icons

Find Resources:
Use „This layer in context“ to find module of an Action
Identify Icon Path in Source Files
Put in Suite's branding Folder
in a folder named like the module
JAR, under the same package:


Replacing Icons

Even Icons that don't exist in the original can be „replaced“
for a better Look & Feel
Example add rollover or disabled icons:


Replacing Icons

Picture Formats
What to do when your Icon collection has different Picture
Format (e.g. gif instead png required)?
Rename your image.png to image.gif
No conversion needed


Branding von Texten

Branding token:


Branding Strings

Branding token is used in addition to locale
Resources stored in „locale“ folder
Search order example, Locale US:
1. Bundle_token_en_US.properties
– Bundle_token_en.properties
– Bundle_token.properties
4. Bundle_en_US.properties
5. Bundle_en.properties
6. Bundle.properties


Look & Feel

Dynamically changing Swing L&F at Runtime
Need to get Hold of Application Frame:
UIManager.setLookAndFeel(new MetalLookAndFeel());
Frame frame =
WindowManager.getDefault().getMainWindow();
SwingUtilities.updateComponentTreeUI(frame);
frame.pack();

UIDelegates need (e.g. Tabs) to be available or created for
Third-party L&F (e.g. Synthetica, Substance)


Accessibility

Resources:
http://a11y.netbeans.org/
a11y Checker Module:
This module checks designed forms online, in
design time.
Provides sortable error list
Highlights affected components
Assists with fixes
Cooperates with i18n


Accessibility

Branding & Internationalization with the NetBeans Platform

Recommended

Recommended

More Related Content

What's hot

What's hot (20)

Similar to Branding & Internationalization with the NetBeans Platform

Similar to Branding & Internationalization with the NetBeans Platform (20)

Recently uploaded

Recently uploaded (20)

Branding & Internationalization with the NetBeans Platform