public final class Dictionary
extends java.lang.Object
Dictionary
is
bound to a named JavaScript object that resides in the global namespace of
the host page's window object. The bound JavaScript object is used directly
as an associative array.
For example, suppose you define the following JavaScript object in your host page:
You can then use avar CurrentTheme = { highlightColor: "#FFFFFF", shadowColor: "#808080", errorColor: "#FF0000", errorIconSrc: "stopsign.gif" };
Dictionary
to access the key/value pairs
above:
public void useThemeDictionary() { Dictionary theme = Dictionary.getDictionary("CurrentTheme"); String highlightColor = theme.get("highlightColor"); String shadowColor = theme.get("shadowColor"); applyShadowStyle(highlightColor, shadowColor); String errorColor = theme.get("errorColor"); String errorIconSrc = theme.get("errorIconSrc"); Image errorImg = new Image(errorIconSrc); showError(errorColor, errorImg); }
Unlike the family of interfaces that extend
Localizable
which support static
internationalization, the Dictionary
class is fully dynamic.
As a result, a variety of error conditions (particularly those involving key
mismatches) cannot be caught until runtime. Similarly, the GWT compiler is
unable discard unused dictionary values since the structure cannot be
statically analyzed.
locale
client property. Thus,
Dictionary
is the most flexible of the internationalization
types and may provide the simplest form of integration with existing
localization systems which were not specifically designed to use GWT's
locale
client property.
See Localizable
for background on the
locale
client property.
com.google.gwt.i18n.I18N
.
<module> <!-- other inherited modules, such as com.google.gwt.user.User --> <inherits name="com.google.gwt.i18n.I18N"/> <!-- additional module settings --> </module>
Modifier and Type | Method and Description |
---|---|
java.lang.String |
get(java.lang.String key)
Get the value associated with the given Dictionary key.
|
static Dictionary |
getDictionary(java.lang.String name)
Returns the
Dictionary object associated with the given
name. |
java.util.Set<java.lang.String> |
keySet()
The set of keys associated with this dictionary.
|
(package private) void |
resourceError(java.lang.String key) |
(package private) static void |
resourceErrorBadType(java.lang.String name) |
java.lang.String |
toString() |
java.util.Collection<java.lang.String> |
values()
Collection of values associated with this dictionary.
|
public static Dictionary getDictionary(java.lang.String name)
Dictionary
object associated with the given
name.name
- java.util.MissingResourceException
static void resourceErrorBadType(java.lang.String name)
public java.lang.String get(java.lang.String key)
key
- to lookupjava.util.MissingResourceException
- if the value is not foundpublic java.util.Set<java.lang.String> keySet()
public java.lang.String toString()
toString
in class java.lang.Object
public java.util.Collection<java.lang.String> values()
void resourceError(java.lang.String key)