1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XResourceBundle.idl,v $
* $Revision: 1.12 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_resource_XResourceBundle_idl__
#define __com_sun_star_resource_XResourceBundle_idl__
#ifndef __com_sun_star_container_XNameAccess_idl__
#include <com/sun/star/container/XNameAccess.idl>
#endif
#ifndef __com_sun_star_lang_Locale_idl__
#include <com/sun/star/lang/Locale.idl>
#endif
//=============================================================================
module com { module sun { module star { module resource {
//=============================================================================
/** Resource bundles contain locale-specific objects.
<p>When your program needs a locale-specific resource, such as
<code>String</code> for example, your program can load it from the
resource bundle that is appropriate for the current user's locale. In
this way, you can write program code that is largely independent of
the user's locale, which isolates most, if not all, of the
locale-specific information in resource bundles.
<p>This allows you to write programs that can:
<UL type=SQUARE>
<LI> be easily localized, or translated, into different
languages.
<LI> handle multiple locales at once.
<LI> be easily modified, later, to support even more locales.
</UL>
<P> One resource bundle is, conceptually, a set of related services
that supports <code>XResourceBundle</code>. Each related service of
<code>XResourceBundle</code> has the same base name plus an
additional component that identifies its locale. For example, suppose
your resource bundle is named <code>MyResources</code>. The first
service you are likely to implement is the default resource bundle,
which has the same name as its family--<code>MyResources</code>. You
can also provide as many related locale-specific services as you need.
For example, perhaps you would provide a German one named
<code>MyResources_de</code>.
<P>
Each related implementation of <code>XResourceBundle</code> contains
the same items, but the items have been translated for the locale
represented by that <code>XResourceBundle</code> implementation. For
example, both <code>MyResources</code> and <code>MyResources_de</code>
may have a <code>String</code> that is used on a button for
confirming operations. In <code>MyResources</code> the
<code>String</code> may contain <code>OK</code> and in
<code>MyResources_de</code> it may contain <code>Gut</code>.
<P>
If there are different resources for different countries, you
can make specializations: for example, <code>MyResources_de_CH</code>
is the German language (de) in Switzerland (CH). If you only want to
modify some of the resources in the specialization, you can do so.
<P>
When your program needs a locale-specific object, it loads
the <code>XResourceBundle</code> implementation using the
<type>XResourceBundleLoader</type> service:
<listing>
XResourceBundle myResources = xLoader.getBundle("MyResources", currentLocale);
</listing>
<p>The first argument specifies the family name of the resource
bundle that contains the object in question. The second argument
indicates the desired locale. <code>getBundle</code> uses these two
arguments to construct the name of the <code>ResourceBundle</code>
subclass it should load according to the following specifications.
<P>The resource bundle lookup searches for services with various
suffixes on the basis of (1) the desired locale and (2) the current
default locale as returned by Locale.getDefault(), and (3) the root
resource bundle (baseclass), in the following order from lower-level
(more specific) to parent-level (less specific):
<p> baseclass + "_" + language1 + "_" + country1 + "_" + variant1
<BR> baseclass + "_" + language1 + "_" + country1
<BR> baseclass + "_" + language1
<BR> baseclass + "_" + language2 + "_" + country2 + "_" + variant2
<BR> baseclass + "_" + language2 + "_" + country2
<BR> baseclass + "_" + language2
<BR> baseclass
<P> For example, if the current default locale is <TT>en_US</TT>, the
locale that the caller is interested in is <TT>fr_CH</TT>, and the
resource bundle name is <TT>MyResources</TT>; resource bundle lookup
will search for the following services, in order:
<BR> <TT>MyResources_fr_CH
<BR> MyResources_fr
<BR> MyResources_en_US
<BR> MyResources_en
<BR> MyResources</TT>
<P> The result of the lookup is a service, but that service may be
backed by a property file on disk. If a lookup fails,
<code>getBundle()</code> throws a
<code>MissingResourceException</code>.
<P> The base service <strong>must</strong> be fully qualified (for
example, <code>myPackage::MyResources</code>, not just
<code>MyResources</code>).
<P> Resource bundles contain key/value pairs. The keys uniquely
identify a locale-specific object in the bundle. Here is an
example of a <code>XResourceBundle</code> implementation that contains
two key/value pairs:
<listing>
class MyResource extends com.sun.star.resource.XResourceBundle
{
// some queryInterface stuff
// ...
public final Object getDirectElement(String key)
{
if (key.equals("okKey")) return "Ok";
if (key.equals("cancelKey")) return "Cancel";
return null;
}
}
</listing>
<p>Keys are always <code>String</code>s. In this example, the keys
are <code>OkKey</code> and <code>CancelKey</code>. In the above
example, the values are also <code>String</code>s--<code>OK</code>
and <code>Cancel</code>--but they do not have to be. The values can
be any type of object.
<P> You retrieve an object from resource bundle using the appropriate
get method. Because <code>OkKey</code> and <code>CancelKey</code>
are both strings, you use <code>getByName</code> to retrieve them:
<listing>
button1 = new Button(myResourceBundle.getByName("OkKey").getString());
button2 = new Button(myResourceBundle.getByName("CancelKey").getString());
</listing>
<p>The get methods all require the key as an argument and return
the object if found. If the object is not found, the get methods
throw a <type scope="com::sun::star::container">NoSuchElementException</type>.
<P> <STRONG>NOTE:</STRONG> You should always supply a base service
with no suffixes. This will be the class of "last resort" if a
locale is requested that does not exist. In fact, you must provide
<I>all</I> of the services in any given inheritance chain for which
you provide a resource. For example, if you provide
<TT>MyResources_fr_BE</TT>, you must provide <I>both</I>
<TT>MyResources</TT> <I>and</I> <TT>MyResources_fr</TT>, or the
resource bundle lookup will not work right.
<P>You do not have to restrict yourself to using a single family of
<code>ResourceBundle</code>s. For example, you could have a set of
bundles for exception messages, <code>ExceptionResources</code>
(<code>ExceptionResources_fr</code>, <code>ExceptionResources_de</code>, ...),
and one for widgets, <code>WidgetResource</code> (<code>WidgetResources_fr</code>,
<code>WidgetResources_de</code>, ...); breaking up the resources however you like.
@see MissingResourceException
@see Locale
@version 0.1 26 May 1999
@author Mark Davis
@author Markus Meyer
@deprecated draft
*/
published interface XResourceBundle: com::sun::star::container::XNameAccess
{
//-------------------------------------------------------------------------
/** contains the parent bundle of this bundle.
<p>The parent bundle is searched by the method
<method scope="com::sun::star::container">XNameAccess::getByName</method>
when this bundle does not contain a particular resource.
*/
[attribute] XResourceBundle Parent;
//-------------------------------------------------------------------------
/** @returns
the locale for this resource bundle.
<p>This function can be used to determine whether the
resource bundle that is returned really corresponds to the
requested locale or is a fallback.
*/
com::sun::star::lang::Locale getLocale();
//-------------------------------------------------------------------------
/** @returns
an object from a resource bundle or NULL if no resource
exists.
<p>It does not look in the parents.
@param key
specifies the element.
*/
any getDirectElement( [in] string key );
};
//=============================================================================
}; }; }; };
#endif
|
