1 |
|
/* AccessibleBundle.java -- base class for accessibility "enumerations" |
2 |
|
Copyright (C) 2002 Free Software Foundation, Inc. |
3 |
|
|
4 |
|
This file is part of GNU Classpath. |
5 |
|
|
6 |
|
GNU Classpath is free software; you can redistribute it and/or modify |
7 |
|
it under the terms of the GNU General Public License as published by |
8 |
|
the Free Software Foundation; either version 2, or (at your option) |
9 |
|
any later version. |
10 |
|
|
11 |
|
GNU Classpath is distributed in the hope that it will be useful, but |
12 |
|
WITHOUT ANY WARRANTY; without even the implied warranty of |
13 |
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
14 |
|
General Public License for more details. |
15 |
|
|
16 |
|
You should have received a copy of the GNU General Public License |
17 |
|
along with GNU Classpath; see the file COPYING. If not, write to the |
18 |
|
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
19 |
|
02111-1307 USA. |
20 |
|
|
21 |
|
Linking this library statically or dynamically with other modules is |
22 |
|
making a combined work based on this library. Thus, the terms and |
23 |
|
conditions of the GNU General Public License cover the whole |
24 |
|
combination. |
25 |
|
|
26 |
|
As a special exception, the copyright holders of this library give you |
27 |
|
permission to link this library with independent modules to produce an |
28 |
|
executable, regardless of the license terms of these independent |
29 |
|
modules, and to copy and distribute the resulting executable under |
30 |
|
terms of your choice, provided that you also meet, for each linked |
31 |
|
independent module, the terms and conditions of the license of that |
32 |
|
module. An independent module is a module which is not derived from |
33 |
|
or based on this library. If you modify this library, you may extend |
34 |
|
this exception to your version of the library, but you are not |
35 |
|
obligated to do so. If you do not wish to do so, delete this |
36 |
|
exception statement from your version. */ |
37 |
|
|
38 |
|
package javax.accessibility; |
39 |
|
|
40 |
|
import java.util.Locale; |
41 |
|
|
42 |
|
/** |
43 |
|
* This serves as a base class for accessibility "enumerations". These |
44 |
|
* objects are strongly typed; to make up for the lack of true enums in Java. |
45 |
|
* Display should be locale dependent. |
46 |
|
* |
47 |
|
* @author Eric Blake <ebb9@email.byu.edu> |
48 |
|
* @see AccessibleRole |
49 |
|
* @see AccessibleState |
50 |
|
* @since 1.2 |
51 |
|
* @status updated to 1.4, but missing Locale support |
52 |
|
*/ |
53 |
|
public abstract class AccessibleBundle |
54 |
|
{ |
55 |
|
/** |
56 |
|
* The locale independent name of the object. This is for the computer, not |
57 |
|
* necessarily for humans; changing it in subclasses is frowned upon. |
58 |
|
* |
59 |
|
* @see #toDisplayString(String, Locale) |
60 |
|
*/ |
61 |
|
protected String key; |
62 |
|
|
63 |
|
/** |
64 |
|
* Default constructor. |
65 |
|
*/ |
66 |
|
public AccessibleBundle() |
67 |
|
{ |
68 |
|
} |
69 |
|
|
70 |
|
/** |
71 |
|
* Obtains the key as a localized string, falling back to the |
72 |
|
* locale-independent version if necessary. |
73 |
|
* |
74 |
|
* @param resourceBundle the resource to use for lookup |
75 |
|
* @param locale the locale to translate to |
76 |
|
* @return the translated name |
77 |
|
* @throws NullPointerException if resourceBundle or locale is null |
78 |
|
* @XXX For now, no transformation is done. |
79 |
|
*/ |
80 |
|
protected String toDisplayString(String resourceBundle, Locale locale) |
81 |
|
{ |
82 |
|
return key; |
83 |
|
} |
84 |
|
|
85 |
|
/** |
86 |
|
* Obtains the key as a localized string, falling back to the |
87 |
|
* locale-independent version if necessary. |
88 |
|
* |
89 |
|
* @param locale the locale to translate to |
90 |
|
* @return the translated name |
91 |
|
* @throws NullPointerException if locale is null |
92 |
|
* @XXX For now, no transformation is done. |
93 |
|
*/ |
94 |
|
public String toDisplayString(Locale locale) |
95 |
|
{ |
96 |
|
return key; |
97 |
|
} |
98 |
|
|
99 |
|
/** |
100 |
|
* Obtains the key as a localized string, using the default locale. |
101 |
|
* |
102 |
|
* @return the translated name |
103 |
|
* @XXX For now, no transformation is done. |
104 |
|
*/ |
105 |
|
public String toDisplayString() |
106 |
|
{ |
107 |
|
return toDisplayString(Locale.getDefault()); |
108 |
|
} |
109 |
|
|
110 |
|
/** |
111 |
|
* Obtains the key as a localized string, using the default locale. |
112 |
|
* |
113 |
|
* @return the translated name |
114 |
|
* @XXX For now, no transformation is done. |
115 |
|
*/ |
116 |
|
public String toString() |
117 |
|
{ |
118 |
|
return toDisplayString(Locale.getDefault()); |
119 |
|
} |
120 |
|
} // class AccessibleBundle |