javax.accessibility
Interface AccessibleComponent
java.lang.Object
|
+--javax.accessibility.AccessibleComponent
public interface AccessibleComponent
Objects which are to be rendered to a screen as part of a graphical
user interface should implement this interface. Accessibility
software can use the implementations of this interface to determine
and set the screen representation for an object.
The AccessibleContext.getAccessibleComponent()
method
should return null
if an object does not implement this
interface.
Since:Author:- Eric Blake <ebb9@email.byu.edu>
See Also:
addFocusListener
public void addFocusListener(java.awt.event.FocusListener listener)
Adds the specified listener to this component.
Parameters:
See Also:
contains
public boolean contains(java.awt.Point point)
Tests whether or not the specified point is contained within
this component. The coordinates are specified relative to this
component's coordinate system.
Parameters:
Returns:
- true if the point is within this component
Throws:
See Also:
getAccessibleAt
public Accessible getAccessibleAt(java.awt.Point point)
If an object exists at the specified point which is a child of this
parent component, and it is accessible, then it is returned.
Parameters:
Returns:
- the accessible child object at that point, or null
getBackground
public Color getBackground()
Get the background color of this component.
Returns:
- the background color of this component, or null if not supported
See Also:
getBounds
public Rectangle getBounds()
Get the bounds of this component relative to its parent - it's width,
height, and relative location to its parent.
Returns:
- the bounds of this component, or null if not on screen
See Also:
getCursor
public Cursor getCursor()
Get the cursor of this component.
Returns:
- the Cursor of this component, or null if not supported
See Also:
getFont
public Font getFont()
Get the font of this component
Returns:
- the font of the component, or null if not supported
See Also:
getFontMetrics
public FontMetrics getFontMetrics(java.awt.Font font)
Get the FontMetrics
of the specified font in this component.
Parameters:
Returns:
- the metrics for the specified font, or null if not supported
Throws:
See Also:
getForeground
public Color getForeground()
Get the foreground color of this component.
Returns:
- the foreground color of this component, or null if not supported
See Also:
getLocation
public Point getLocation()
Get the location of this component in the parent's coordinate system.
The point specified is the top-left corner of this component.
Returns:
- the location in the parent on screen, or null if off-screen
See Also:
getLocationOnScreen
public Point getLocationOnScreen()
Get the location of this component in the screen's coordinate space.
The point specified is the top-left corner of this component.
Returns:
- the location on screen, or null if off-screen
See Also:
getSize
public Dimension getSize()
Get the size of this component - it's width and height.
Returns:
- the dimensions of this component, or null if not on screen
See Also:
isEnabled
public boolean isEnabled()
Indicates whether or not this component is enabled. An object which is
enabled also has AccessibleState.ENABLED in its StateSet.
Returns:
- true if the component is enabled
See Also:
isFocusTraversable
public boolean isFocusTraversable()
Indicates whether or not this component can accept focus. An object
which can accept focus also has AccessibleState.FOCUSABLE in its
StateSet.
Returns:
- true if the component can accept focus
See Also:
isShowing
public boolean isShowing()
Indicates whether or not this component is visible by checking
the visibility of this component and its ancestors. The component may
be hidden on screen by another component like pop-up help. An object
which is showing on screen also has AccessibleState.SHOWING in its
StateSet.
Returns:
- true if component and ancestors are visible
See Also:
isVisible
public boolean isVisible()
Indicates whether or not this component is visible or intends to be
visible although one of its ancestors may not be. An object which is
visible also has AccessibleState.VISIBLE in its StateSet. Check
isShowing()
to see if the object is on screen.
Returns:
- true if the component is visible
See Also:
removeFocusListener
public void removeFocusListener(java.awt.event.FocusListener listener)
Removes the specified listener from this component.
Parameters:
See Also:
requestFocus
public void requestFocus()
If this method is called this component will attempt to gain focus,
but if it cannot accept focus nothing happens. On success, the StateSet
will contain AccessibleState.FOCUSED
See Also:
setBackground
public void setBackground(java.awt.Color color)
Set the background color of this component to the specified color.
Parameters:
See Also:
setBounds
public void setBounds(java.awt.Rectangle rectangle)
Set the bounds of this component to the specified height and width, and
relative location to its parent.
Parameters:
Throws:
setCursor
public void setCursor(java.awt.Cursor cursor)
Set the cursor of the component.
Parameters:
See Also:
setEnabled
public void setEnabled(boolean b)
Set this component to an enabled or disabled state.
Parameters:
See Also:
setFont
public void setFont(java.awt.Font font)
Set the font of this component.
Parameters:
See Also:
setForeground
public void setForeground(java.awt.Color color)
Set the foreground color of this component.
Parameters:
See Also:
setLocation
public void setLocation(java.awt.Point point)
Set the location of this component relative to its parent. The point
specified represents the top-left corner of this component.
Parameters:
Throws:
See Also:
setSize
public void setSize(java.awt.Dimension dimension)
Set the size of this component to the given dimensions.
Parameters:
Throws:
See Also:
setVisible
public void setVisible(boolean b)
Set the visible state of this component.
Parameters:
See Also:
The
AccessibleContext.getAccessibleComponent()
method should returnnull
if an object does not implement this interface.