Class AccessibleBundle

java.lang.Object
- javax.accessibility.AccessibleBundle

Direct Known Subclasses:: AccessibleRelation, AccessibleRole, AccessibleState

public abstract class AccessibleBundle
extends Object

Base class used to maintain a strongly typed enumeration. This is the superclass of AccessibleState and AccessibleRole.

The toDisplayString method allows you to obtain the localized string for a locale independent key from a predefined ResourceBundle for the keys defined in this class. This localized string is intended to be readable by humans.

See Also:: AccessibleRole, AccessibleState

Fields

Modifier and Type	Field and Description
`protected String`	`key` The locale independent name of the state.

Constructors

Constructor and Description
`AccessibleBundle()` Construct an `AccessibleBundle`.

Methods

Modifier and Type	Method and Description
`String`	`toDisplayString()` Gets localized string describing the key using the default locale.
`String`	`toDisplayString(Locale locale)` Obtains the key as a localized string.
`protected String`	`toDisplayString(String resourceBundleName, Locale locale)` Obtains the key as a localized string.
`String`	`toString()` Gets localized string describing the key using the default locale.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Fields

key

protected String key

The locale independent name of the state. This is a programmatic name that is not intended to be read by humans.

See Also:: toDisplayString(java.lang.String, java.util.Locale)

Constructors

AccessibleBundle

public AccessibleBundle()

Construct an AccessibleBundle.

Methods

toDisplayString

protected String toDisplayString(String resourceBundleName,
                                 Locale locale)

Obtains the key as a localized string. If a localized string cannot be found for the key, the locale independent key stored in the role will be returned. This method is intended to be used only by subclasses so that they can specify their own resource bundles which contain localized strings for their keys.

Parameters:: resourceBundleName - the name of the resource bundle to use for lookup; locale - the locale for which to obtain a localized string
Returns:: a localized String for the key.

toDisplayString

public String toDisplayString(Locale locale)

Obtains the key as a localized string. If a localized string cannot be found for the key, the locale independent key stored in the role will be returned.

Parameters:: locale - the locale for which to obtain a localized string
Returns:: a localized String for the key.

toDisplayString

public String toDisplayString()

Gets localized string describing the key using the default locale.

Returns:: a localized String describing the key for the default locale

toString

public String toString()

Gets localized string describing the key using the default locale.

Overrides:: toString in class Object
Returns:: a localized String describing the key using the default locale
See Also:: toDisplayString(java.lang.String, java.util.Locale)

© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/javase/8/docs/api/javax/accessibility/AccessibleBundle.html