Accessible
, AccessibleComponent
public class Translator extends AccessibleContext implements Accessible, AccessibleComponent
The Translator
class provides a translation to interface Accessible
for objects that do not implement interface Accessible
. Assistive technologies can use the getAccessible
class method of Translator
to obtain an object that implements interface Accessible
. If the object passed in already implements interface Accessible
, getAccessible
merely returns the object.
An example of how an assistive technology might use the Translator
class is as follows:
Accessible accessible = Translator.getAccessible(someObj); // obtain information from the 'accessible' object.
Note: This implementation is missing many things and is not a recommended way to implement accessibility features for a toolkit. Instead of relying upon this code, a toolkit's components should implement interface Accessible
directly.
Modifier and Type | Field | Description |
---|---|---|
protected Object |
source |
The source object needing translating. |
ACCESSIBLE_ACTION_PROPERTY, ACCESSIBLE_ACTIVE_DESCENDANT_PROPERTY, ACCESSIBLE_CARET_PROPERTY, ACCESSIBLE_CHILD_PROPERTY, ACCESSIBLE_COMPONENT_BOUNDS_CHANGED, ACCESSIBLE_DESCRIPTION_PROPERTY, ACCESSIBLE_HYPERTEXT_OFFSET, ACCESSIBLE_INVALIDATE_CHILDREN, ACCESSIBLE_NAME_PROPERTY, ACCESSIBLE_SELECTION_PROPERTY, ACCESSIBLE_STATE_PROPERTY, ACCESSIBLE_TABLE_CAPTION_CHANGED, ACCESSIBLE_TABLE_COLUMN_DESCRIPTION_CHANGED, ACCESSIBLE_TABLE_COLUMN_HEADER_CHANGED, ACCESSIBLE_TABLE_MODEL_CHANGED, ACCESSIBLE_TABLE_ROW_DESCRIPTION_CHANGED, ACCESSIBLE_TABLE_ROW_HEADER_CHANGED, ACCESSIBLE_TABLE_SUMMARY_CHANGED, ACCESSIBLE_TEXT_ATTRIBUTES_CHANGED, ACCESSIBLE_TEXT_PROPERTY, ACCESSIBLE_VALUE_PROPERTY, ACCESSIBLE_VISIBLE_DATA_PROPERTY, accessibleDescription, accessibleName, accessibleParent
Constructor | Description |
---|---|
Translator() |
Create a new Translator . |
Translator |
Create a new Translator with the source object o. |
Modifier and Type | Method | Description |
---|---|---|
void |
addFocusListener |
Adds the specified FocusListener to receive focus events from this component. |
void |
addPropertyChangeListener |
Add a PropertyChangeListener to the listener list. |
boolean |
contains |
Checks whether the specified Point is within this object's bounds, where the Point is relative to the coordinate system of the object. |
boolean |
equals |
Returns true if this object is the same as the one passed in. |
static Accessible |
getAccessible |
Obtain an object that implements interface Accessible . |
Accessible |
getAccessibleAt |
Returns the accessible child contained at the local coordinate Point, if one exists. |
Accessible |
getAccessibleChild |
Return the nth accessible child of the object. |
int |
getAccessibleChildrenCount() |
Returns the number of accessible children in the object. |
AccessibleContext |
getAccessibleContext() |
Returns this object. |
String |
getAccessibleDescription() |
Get the accessible description of this object. |
int |
getAccessibleIndexInParent() |
Get the index of this object in its accessible parent. |
String |
getAccessibleName() |
Get the accessible name of this object. |
Accessible |
getAccessibleParent() |
Get the accessible parent of this object. |
AccessibleRole |
getAccessibleRole() |
Get the role of this object. |
AccessibleStateSet |
getAccessibleStateSet() |
Get the state of this object, given an already populated state. |
Color |
getBackground() |
Get the background Color of this object. |
Rectangle |
getBounds() |
Returns the current bounds of this object. |
Cursor |
getCursor() |
Get the Cursor of this object. |
Font |
getFont() |
Get the Font of this object. |
FontMetrics |
getFontMetrics |
Get the FontMetrics of this object. |
Color |
getForeground() |
Get the foreground Color of this object. |
Locale |
getLocale() |
Gets the Locale of the component. |
Point |
getLocation() |
Returns the location of the object relative to parent. |
Point |
getLocationOnScreen() |
Returns the location of the object on the screen. |
Dimension |
getSize() |
Returns the current size of this object. |
Object |
getSource() |
Get the source Object of the Translator . |
protected static Class |
getTranslatorClass |
Find a translator for this class. |
int |
hashCode() |
Return hashcode. |
boolean |
isEnabled() |
Determine if the object is enabled. |
boolean |
isFocusTraversable() |
Returns whether this object can accept focus or not. |
boolean |
isShowing() |
Determine if the object is showing. |
boolean |
isVisible() |
Determine if the object is visible. |
void |
removeFocusListener |
Removes the specified focus listener so it no longer receives focus events from this component. |
void |
removePropertyChangeListener |
Remove the PropertyChangeListener from the listener list. |
void |
requestFocus() |
Requests focus for this object. |
void |
setAccessibleDescription |
Set the accessible description of this object. |
void |
setAccessibleName |
Set the name of this object. |
void |
setBackground |
Set the background Color of this object. |
void |
setBounds |
Sets the current bounds of this object. |
void |
setCursor |
Set the Cursor of this object. |
void |
setEnabled |
Set the enabled state of the object. |
void |
setFont |
Set the Font of this object. |
void |
setForeground |
Set the foreground Color of this object. |
void |
setLocation |
Sets the location of the object relative to parent. |
void |
setSize |
Sets the current size of this object. |
void |
setSource |
Set the source object of the Translator . |
void |
setVisible |
Set the visible state of the object. |
firePropertyChange, getAccessibleAction, getAccessibleComponent, getAccessibleEditableText, getAccessibleIcon, getAccessibleRelationSet, getAccessibleSelection, getAccessibleTable, getAccessibleText, getAccessibleValue, setAccessibleParent
protected Object source
public Translator()
Translator
. You must call the setSource
method to set the object to be translated after calling this constructor.public Translator(Object o)
Translator
with the source object o.o
- the Component that does not implement interface Accessible
protected static Class<?> getTranslatorClass(Class<?> c)
c
- a ClassTranslator
Class for the Class passed inpublic static Accessible getAccessible(Object o)
Accessible
. If the object passed in already implements interface Accessible
, getAccessible
merely returns the object.o
- an Object; if a null is passed in a null is returnedObject
, possibly the Object
passed in, that implements the Accessible
interface for the Object
which was passed inpublic Object getSource()
Object
of the Translator
.Object
of the Translator
public void setSource(Object o)
Translator
.o
- the Component that does not implement interface Accessiblepublic boolean equals(Object o)
public int hashCode()
public AccessibleContext getAccessibleContext()
getAccessibleContext
in interface Accessible
AccessibleContext
associated with this objectpublic String getAccessibleName()
getAccessibleName
in class AccessibleContext
public void setAccessibleName(String s)
setAccessibleName
in class AccessibleContext
s
- the new localized name of the objectpublic String getAccessibleDescription()
getAccessibleDescription
in class AccessibleContext
public void setAccessibleDescription(String s)
setAccessibleDescription
in class AccessibleContext
s
- the new localized description of the objectpublic AccessibleRole getAccessibleRole()
getAccessibleRole
in class AccessibleContext
public AccessibleStateSet getAccessibleStateSet()
getAccessibleStateSet
in class AccessibleContext
AccessibleStateSet
containing the current state of the objectpublic Accessible getAccessibleParent()
getAccessibleParent
in class AccessibleContext
public int getAccessibleIndexInParent()
getAccessibleIndexInParent
in class AccessibleContext
public int getAccessibleChildrenCount()
getAccessibleChildrenCount
in class AccessibleContext
public Accessible getAccessibleChild(int i)
getAccessibleChild
in class AccessibleContext
i
- zero-based index of childpublic Locale getLocale() throws IllegalComponentStateException
Locale
of the component. If the component does not have a locale, the locale of its parent is returned.getLocale
in class AccessibleContext
Locale
of the objectIllegalComponentStateException
- If the component does not have its own locale and has not yet been added to a containment hierarchy such that the locale can be determined from the containing parentpublic void addPropertyChangeListener(PropertyChangeListener l)
PropertyChangeListener
to the listener list. The listener is registered for all properties.addPropertyChangeListener
in class AccessibleContext
l
- The PropertyChangeListener to be addedpublic void removePropertyChangeListener(PropertyChangeListener l)
PropertyChangeListener
from the listener list.removePropertyChangeListener
in class AccessibleContext
l
- The PropertyChangeListener to be removedpublic Color getBackground()
Color
of this object.getBackground
in interface AccessibleComponent
Color
of the object; otherwise, nullpublic void setBackground(Color c)
Color
of this object.setBackground
in interface AccessibleComponent
c
- the new Color
for the backgroundpublic Color getForeground()
Color
of this object.getForeground
in interface AccessibleComponent
Color
of the object; otherwise, nullpublic void setForeground(Color c)
Color
of this object.setForeground
in interface AccessibleComponent
c
- the new Color
for the foregroundpublic Cursor getCursor()
Cursor
of this object.getCursor
in interface AccessibleComponent
public void setCursor(Cursor c)
Cursor
of this object.setCursor
in interface AccessibleComponent
c
- the new Cursor
for the objectpublic Font getFont()
Font
of this object.getFont
in interface AccessibleComponent
Font
for the object; otherwise, nullpublic void setFont(Font f)
Font
of this object.setFont
in interface AccessibleComponent
f
- the new Font
for the objectpublic FontMetrics getFontMetrics(Font f)
FontMetrics
of this object.getFontMetrics
in interface AccessibleComponent
f
- the Font
FontMetrics
the object; otherwise, nullpublic boolean isEnabled()
isEnabled
in interface AccessibleComponent
public void setEnabled(boolean b)
setEnabled
in interface AccessibleComponent
b
- if true, enables this object; otherwise, disables itpublic boolean isVisible()
isVisible
in interface AccessibleComponent
public void setVisible(boolean b)
setVisible
in interface AccessibleComponent
b
- if true, shows this object; otherwise, hides itpublic boolean isShowing()
isShowing
in interface AccessibleComponent
public boolean contains(Point p)
Point
is within this object's bounds, where the Point
is relative to the coordinate system of the object.contains
in interface AccessibleComponent
p
- the Point
relative to the coordinate system of the objectPoint
; otherwise falsepublic Point getLocationOnScreen()
getLocationOnScreen
in interface AccessibleComponent
public Point getLocation()
getLocation
in interface AccessibleComponent
public void setLocation(Point p)
setLocation
in interface AccessibleComponent
p
- the new position for the top-left cornerpublic Rectangle getBounds()
getBounds
in interface AccessibleComponent
public void setBounds(Rectangle r)
setBounds
in interface AccessibleComponent
r
- rectangle indicating this component's boundspublic Dimension getSize()
getSize
in interface AccessibleComponent
public void setSize(Dimension d)
setSize
in interface AccessibleComponent
d
- The dimension specifying the new size of the objectpublic Accessible getAccessibleAt(Point p)
getAccessibleAt
in interface AccessibleComponent
p
- The point relative to the coordinate system of this objectpublic boolean isFocusTraversable()
isFocusTraversable
in interface AccessibleComponent
public void requestFocus()
requestFocus
in interface AccessibleComponent
public void addFocusListener(FocusListener l)
FocusListener
to receive focus events from this component.addFocusListener
in interface AccessibleComponent
l
- the focus listenerpublic void removeFocusListener(FocusListener l)
removeFocusListener
in interface AccessibleComponent
l
- the focus listener; this method performs no function, nor does it throw an exception if the listener specified was not previously added to this component; if listener is null, no exception is thrown and no action is performed.
© 1993, 2023, 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/en/java/javase/21/docs/api/jdk.accessibility/com/sun/java/accessibility/util/Translator.html