Examples of com.bbn.openmap.I18n

• com.bbn.openmap.I18n
  Interface for Internationalization support in Openamp. The I18n implmentation will define where the resources for the given class are stored.

  Intended Usage:

  There are several possible uses of this interface, outlined below:

  • Simple Usage:
    The simplest case is where you just want to get the possibly internationalized version of a given string. This would look like the following:

    I18n i18n = Environment.getI18n();
String message = i18n.get(this, "message", "Please enter a number: ");


    There is also similar version of get(...) that takes a Class instead, and thefore can be used in static contexts. If the Strings you are looking for pertain to specific types (i.e. uses) you can you the form of get(...) that specifies this, as the following example illustrates:

    I18n i18n = Environment.getI18n();
JButton okButton = new JButton(i18n.get(this, "okButton", i18n.TEXT, "Ok"));
okButton.setTooltipText(i18n.get(this, "okButton", i18n.TOOLTOP, "Ok"));


    Again there is a similar version of this method that takes a Class instead of an object so it can be used in static contexts.

    Note that in both examples given, the field parameter to the get(...) methods are the name of the variable that holds the string returned. For the these methods, this is a convention rather than a requirement. However, it suggested that you maintain this convention because doing so makes it clearer what is going on and because it is most similar to how the calls are made in the reflective case below.

    Note also that there are several additional get(...) methods that can be used to make getting paramaterized (as if by MessageFormat) Strings easier.

  • Swing Usage:
    If you are setting the text fields on Swing objects, the set(...) methods of this class can help you. Here is an example:

    I18n i18n = Environment.getI18n();
JButton myButton = new JButton();
I18n.set(this, "myButton", myButton);


    This will get the string information (both tool tip and text) from the appropriate ResourceBundle and set the button's slots with it.

    Note that in this example the field parameter to the set(...) method is the name of the field that holds the object being setup. For these methods this is a convention rather than a requirement. However, it suggested that you maintain this convention because doing so makes it clearer what is going on and because it is most similar to how the calls are made in the reflective case below.

  • Reflective Calls:
    For the typical uses of this class, there are two calls that can make things very easy, by doing a bunch of the work for you. In most implementations if this interface, they will accomplish this via reflection under-the-hood. Here are some examples:

    public class MyClass {
  JButton myButton = new JButton();
  public MyClass() {
    Environment.getI18n().set(this, "myButton");
  }
}


    This code will setup the properties of the object held by the myButton variable, without the programmer having to do much at all. Here is an example of the other reflective method:

    public class MyClass {
  JButton myButton = new JButton();
  JLabel myLabel = new JLabel();   public MyClass() {
    Environment.getI18n().fill(this);
  }
}


    Here we can see that a single call is filling in all of the text for all of the relevant objects, in this case both myButton and myLabel.

  In case you were wondering, the oft used I18n abreviation comes from the 18 characters between the 'I' and the 'n' in the word Internationalization. @see com.bbn.openmap.Environment @see com.bbn.openmap.BasicI18n

Related Classes of com.bbn.openmap.I18n