All Packages Class Hierarchy This Package Previous Next Index
Class com.sun.java.accessibility.util.Translator
java.lang.Object
|
+----com.sun.java.accessibility.AccessibleContext
|
+----com.sun.java.accessibility.util.Translator
- 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 is proof-of-concept code and is missing many things. It
is also an undesirable way to implement accessibility features for a
Toolkit. Instead of relying upon this code, the Toolkit's Components
should implement interface Accessible directly. This is also a preliminary
draft. The methods and name may change in future beta releases.
-
source
- The source object needing translating.
-
Translator()
- Create a new Translator.
-
Translator(Object)
- Create a new Translator with the source object o.
-
addFocusListener(FocusListener)
- Adds the specified focus listener to receive focus events from this
component.
-
addPropertyChangeListener(PropertyChangeListener)
- Add a PropertyChangeListener to the listener list.
-
contains(Point)
-
Checks whether the specified Point is within this object's bounds,
where the Point is relative to the coordinate system of the object.
-
equals(Object)
- Returns true if this object is the same as the one passed in.
-
getAccessible(Object)
-
Obtain an object that implements interface Accessible.
-
getAccessibleAt(Point)
- Returns the Accessible child contained at the local coordinate
Point, if one exists.
-
getAccessibleChild(int)
- Return the nth Accessible child of the object.
-
getAccessibleChildrenCount()
- Returns the number of accessible children in the object.
-
getAccessibleContext()
- Returns this object.
-
getAccessibleDescription()
- Get the accessible description of this object.
-
getAccessibleIndexInParent()
- Get the index of this object in its accessible parent.
-
getAccessibleName()
- Get the accessible name of this object.
-
getAccessibleParent()
- Get the Accessible parent of this object.
-
getAccessibleRole()
- Get the role of this object.
-
getAccessibleStateSet()
- Get the state of this object, given an already populated state.
-
getBackground()
- Get the background color of this object.
-
getBounds()
-
Returns the current bounds of this object
-
getCursor()
- Get the Cursor of this object.
-
getFont()
- Get the Font of this object.
-
getFontMetrics(Font)
- Get the FontMetrics of this object.
-
getForeground()
- Get the foreground color of this object.
-
getLocale()
- Gets the locale of the component.
-
getLocation()
-
Returns the location of the object relative to parent.
-
getLocationOnScreen()
-
Returns the location of the object on the screen.
-
getSize()
-
Returns the current size of this object
-
getSource()
- Get the source object of the Translator.
-
getTranslatorClass(Class)
- Find a translator for this class.
-
isEnabled()
- Determine if the object is enabled.
-
isFocusTraversable()
- Returns whether this object can accept focus or not.
-
isShowing()
- Determine if the object is showing.
-
isVisible()
- Determine if the object is visible.
-
removeFocusListener(FocusListener)
- Removes the specified focus listener so it no longer receives focus
events from this component.
-
removePropertyChangeListener(PropertyChangeListener)
- Remove the PropertyChangeListener from the listener list.
-
requestFocus()
- Requests focus for this object.
-
setAccessibleDescription(String)
- Set the accessible description of this object.
-
setAccessibleName(String)
- Set the name of this object.
-
setBackground(Color)
- Set the background color of this object.
-
setBounds(Rectangle)
-
Sets the current bounds of this object
-
setCursor(Cursor)
- Set the Cursor of this object.
-
setEnabled(boolean)
- Set the enabled state of the object.
-
setFont(Font)
- Set the Font of this object.
-
setForeground(Color)
- Set the foreground color of this object.
-
setLocation(Point)
-
Sets the location of the object relative to parent.
-
setSize(Dimension)
-
Sets the current size of this object
-
setSource(Object)
- Set the source object of the Translator.
-
setVisible(boolean)
- Set the visible state of the object.
source
protected Object source
- The source object needing translating.
Translator
public Translator()
- Create a new Translator. You must call the setSource method to
set the object to be translated after calling this constructor.
Translator
public Translator(Object o)
- Create a new Translator with the source object o.
- Parameters:
- o - the Component that does not implement interface Accessible
getTranslatorClass
protected static Class getTranslatorClass(Class c)
- Find a translator for this class. If one doesn't exist for this
class explicitly, try its superclass and so on.
getAccessible
public static Accessible getAccessible(Object o)
- Obtain an object that implements interface Accessible. If the object
passed in already implements interface Accessible, getAccessible merely
returns the object.
getSource
public Object getSource()
- Get the source object of the Translator.
- Returns:
- the source object of the Translator
setSource
public void setSource(Object o)
- Set the source object of the Translator.
- Parameters:
- o - the Component that does not implement interface Accessible
equals
public boolean equals(Object o)
- Returns true if this object is the same as the one passed in.
- Parameters:
- c - the Component to check against.
- Returns:
- true if this is the same object.
- Overrides:
- equals in class Object
getAccessibleContext
public AccessibleContext getAccessibleContext()
- Returns this object.
getAccessibleName
public String getAccessibleName()
- Get the accessible name of this object.
- Returns:
- the localized name of the object -- can be null if this object
does not have a name
- Overrides:
- getAccessibleName in class AccessibleContext
setAccessibleName
public void setAccessibleName(String s)
- Set the name of this object.
- Overrides:
- setAccessibleName in class AccessibleContext
getAccessibleDescription
public String getAccessibleDescription()
- Get the accessible description of this object.
- Returns:
- the description of the object -- can be null if this object does
not have a description
- Overrides:
- getAccessibleDescription in class AccessibleContext
setAccessibleDescription
public void setAccessibleDescription(String s)
- Set the accessible description of this object.
- Parameters:
- s - the new localized description of the object
- Overrides:
- setAccessibleDescription in class AccessibleContext
getAccessibleRole
public AccessibleRole getAccessibleRole()
- Get the role of this object.
- Returns:
- an instance of AccessibleRole describing the role of the object
- Overrides:
- getAccessibleRole in class AccessibleContext
getAccessibleStateSet
public AccessibleStateSet getAccessibleStateSet()
- Get the state of this object, given an already populated state.
This method is intended for use by subclasses so they don't have
to check for everything.
- Returns:
- an instance of AccessibleStateSet containing the current
state of the object
- Overrides:
- getAccessibleStateSet in class AccessibleContext
getAccessibleParent
public Accessible getAccessibleParent()
- Get the Accessible parent of this object.
- Returns:
- the Accessible parent of this object -- can be null if this
object does not have an Accessible parent
- Overrides:
- getAccessibleParent in class AccessibleContext
getAccessibleIndexInParent
public int getAccessibleIndexInParent()
- Get the index of this object in its accessible parent.
- Returns:
- -1 of this object does not have an accessible parent.
Otherwise, the index of the child in its accessible parent.
- Overrides:
- getAccessibleIndexInParent in class AccessibleContext
getAccessibleChildrenCount
public int getAccessibleChildrenCount()
- Returns the number of accessible children in the object.
- Returns:
- the number of accessible children in the object.
- Overrides:
- getAccessibleChildrenCount in class AccessibleContext
getAccessibleChild
public Accessible getAccessibleChild(int i)
- Return the nth Accessible child of the object.
- Parameters:
- i - zero-based index of child
- Returns:
- the nth Accessible child of the object
- Overrides:
- getAccessibleChild in class AccessibleContext
getLocale
public Locale getLocale() throws IllegalComponentStateException
- Gets the locale of the component. If the component does not have a
locale, the locale of its parent is returned.
- Returns:
- the Locale of the object.
- Overrides:
- getLocale in class AccessibleContext
- See Also:
- setLocale
addPropertyChangeListener
public void addPropertyChangeListener(PropertyChangeListener l)
- Add a PropertyChangeListener to the listener list. The listener is
registered for all properties.
- Overrides:
- addPropertyChangeListener in class AccessibleContext
removePropertyChangeListener
public void removePropertyChangeListener(PropertyChangeListener l)
- Remove the PropertyChangeListener from the listener list.
- Overrides:
- removePropertyChangeListener in class AccessibleContext
getBackground
public Color getBackground()
- Get the background color of this object.
- Returns:
- if supported, the background color of the object;
otherwise, null
setBackground
public void setBackground(Color c)
- Set the background color of this object.
- Parameters:
- c - the new Color for the background
getForeground
public Color getForeground()
- Get the foreground color of this object.
- Returns:
- if supported, the foreground color of the object; otherwise, null
setForeground
public void setForeground(Color c)
- Set the foreground color of this object.
- Parameters:
- c - the new Color for the foreground
getCursor
public Cursor getCursor()
- Get the Cursor of this object.
- Returns:
- if supported, the Cursor of the object; otherwise, null
setCursor
public void setCursor(Cursor c)
- Set the Cursor of this object.
- Parameters:
- c - the new Cursor for the object
getFont
public Font getFont()
- Get the Font of this object.
- Returns:
- if supported, the Font for the object; otherwise, null
setFont
public void setFont(Font f)
- Set the Font of this object.
- Parameters:
- f - the new Font for the object
getFontMetrics
public FontMetrics getFontMetrics(Font f)
- Get the FontMetrics of this object.
- Parameters:
- f - the Font
- Returns:
- if supported, the FontMetrics the object; otherwise, null
- See Also:
- getFont
isEnabled
public boolean isEnabled()
- Determine if the object is enabled.
- Returns:
- true if object is enabled; otherwise, false
setEnabled
public void setEnabled(boolean b)
- Set the enabled state of the object.
- Parameters:
- b - if true, enables this object; otherwise, disables it
isVisible
public boolean isVisible()
- Determine if the object is visible.
- Returns:
- true if object is visible; otherwise, false
setVisible
public void setVisible(boolean b)
- Set the visible state of the object.
- Parameters:
- b - if true, shows this object; otherwise, hides it
isShowing
public boolean isShowing()
- Determine if the object is showing. This is determined by checking
the visibility of the object and ancestors of the object.
- Returns:
- true if object is showing; otherwise, false
contains
public boolean contains(Point p)
- Checks whether the specified Point is within this object's bounds,
where the Point is relative to the coordinate system of the object.
- Parameters:
- p - the Point relative to the coordinate system of the object
- Returns:
- true if object contains Point; otherwise false
getLocationOnScreen
public Point getLocationOnScreen()
- Returns the location of the object on the screen.
- Returns:
- location of object on screen -- can be null if this object
is not on the screen
getLocation
public Point getLocation()
- Returns the location of the object relative to parent.
- Returns:
- location of object relative to parent -- can be null if
this object or its parent are not on the screen
setLocation
public void setLocation(Point p)
- Sets the location of the object relative to parent.
getBounds
public Rectangle getBounds()
- Returns the current bounds of this object
- Returns:
- current bounds of object -- can be null if this object
is not on the screen
setBounds
public void setBounds(Rectangle r)
- Sets the current bounds of this object
getSize
public Dimension getSize()
- Returns the current size of this object
- Returns:
- current size of object -- can be null if this object is
not on the screen
setSize
public void setSize(Dimension d)
- Sets the current size of this object
getAccessibleAt
public Accessible getAccessibleAt(Point p)
- Returns the Accessible child contained at the local coordinate
Point, if one exists.
- Returns:
- the Accessible at the specified location, if it exists
isFocusTraversable
public boolean isFocusTraversable()
- Returns whether this object can accept focus or not.
- Returns:
- true if object can accept focus; otherwise false
requestFocus
public void requestFocus()
- Requests focus for this object.
addFocusListener
public synchronized void addFocusListener(FocusListener l)
- Adds the specified focus listener to receive focus events from this
component.
- Parameters:
- l - the focus listener
removeFocusListener
public synchronized void removeFocusListener(FocusListener l)
- Removes the specified focus listener so it no longer receives focus
events from this component.
- Parameters:
- l - the focus listener
All Packages Class Hierarchy This Package Previous Next Index