public interface

AccessibleComponent

javax.accessibility.AccessibleComponent
Known Indirect Subclasses

Class Overview

The AccessibleComponent interface should be supported by any object that is rendered on the screen. This interface provides the standard mechanism for an assistive technology to determine and set the graphical representation of an object. Applications can determine if an object supports the AccessibleComponent interface by first obtaining its AccessibleContext and then calling the getAccessibleComponent() method. If the return value is not null, the object supports this interface.

Summary

Public Methods
abstract void addFocusListener(FocusListener l)
Adds the specified focus listener to receive focus events from this component.
abstract boolean contains(Point p)
Checks whether the specified point is within this object's bounds, where the point's x and y coordinates are defined to be relative to the coordinate system of the object.
abstract Accessible getAccessibleAt(Point p)
Returns the Accessible child, if one exists, contained at the local coordinate Point.
abstract Color getBackground()
Gets the background color of this object.
abstract Rectangle getBounds()
Gets the bounds of this object in the form of a Rectangle object.
abstract Cursor getCursor()
Gets the Cursor of this object.
abstract Font getFont()
Gets the Font of this object.
abstract FontMetrics getFontMetrics(Font f)
Gets the FontMetrics of this object.
abstract Color getForeground()
Gets the foreground color of this object.
abstract Point getLocation()
Gets the location of the object relative to the parent in the form of a point specifying the object's top-left corner in the screen's coordinate space.
abstract Point getLocationOnScreen()
Returns the location of the object on the screen.
abstract Dimension getSize()
Returns the size of this object in the form of a Dimension object.
abstract boolean isEnabled()
Determines if the object is enabled.
abstract boolean isFocusTraversable()
Returns whether this object can accept focus or not.
abstract boolean isShowing()
Determines if the object is showing.
abstract boolean isVisible()
Determines if the object is visible.
abstract void removeFocusListener(FocusListener l)
Removes the specified focus listener so it no longer receives focus events from this component.
abstract void requestFocus()
Requests focus for this object.
abstract void setBackground(Color c)
Sets the background color of this object.
abstract void setBounds(Rectangle r)
Sets the bounds of this object in the form of a Rectangle object.
abstract void setCursor(Cursor cursor)
Sets the Cursor of this object.
abstract void setEnabled(boolean b)
Sets the enabled state of the object.
abstract void setFont(Font f)
Sets the Font of this object.
abstract void setForeground(Color c)
Sets the foreground color of this object.
abstract void setLocation(Point p)
Sets the location of the object relative to the parent.
abstract void setSize(Dimension d)
Resizes this object so that it has width and height.
abstract void setVisible(boolean b)
Sets the visible state of the object.

Public Methods

public abstract void addFocusListener (FocusListener l)

Adds the specified focus listener to receive focus events from this component.

Parameters
l the focus listener

public abstract boolean contains (Point p)

Checks whether the specified point is within this object's bounds, where the point's x and y coordinates are defined to be 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
See Also

public abstract Accessible getAccessibleAt (Point p)

Returns the Accessible child, if one exists, contained at the local coordinate Point.

Parameters
p The point relative to the coordinate system of this object.
Returns
  • the Accessible, if it exists, at the specified location; otherwise null

public abstract Color getBackground ()

Gets the background color of this object.

Returns
  • the background color, if supported, of the object; otherwise, null

public abstract Rectangle getBounds ()

Gets the bounds of this object in the form of a Rectangle object. The bounds specify this object's width, height, and location relative to its parent.

Returns
  • A rectangle indicating this component's bounds; null if this object is not on the screen.
See Also

public abstract Cursor getCursor ()

Gets the Cursor of this object.

Returns
  • the Cursor, if supported, of the object; otherwise, null

public abstract Font getFont ()

Gets the Font of this object.

Returns
  • the Font,if supported, for the object; otherwise, null
See Also

public abstract FontMetrics getFontMetrics (Font f)

Gets the FontMetrics of this object.

Parameters
f the Font
Returns
  • the FontMetrics, if supported, the object; otherwise, null
See Also

public abstract Color getForeground ()

Gets the foreground color of this object.

Returns
  • the foreground color, if supported, of the object; otherwise, null

public abstract Point getLocation ()

Gets the location of the object relative to the parent in the form of a point specifying the object's top-left corner in the screen's coordinate space.

Returns
  • An instance of Point representing the top-left corner of the object's bounds in the coordinate space of the screen; null if this object or its parent are not on the screen

public abstract Point getLocationOnScreen ()

Returns the location of the object on the screen.

Returns
  • the location of the object on screen; null if this object is not on the screen

public abstract Dimension getSize ()

Returns the size of this object in the form of a Dimension object. The height field of the Dimension object contains this object's height, and the width field of the Dimension object contains this object's width.

Returns
  • A Dimension object that indicates the size of this component; null if this object is not on the screen

public abstract boolean isEnabled ()

Determines if the object is enabled. Objects that are enabled will also have the AccessibleState.ENABLED state set in their AccessibleStateSets.

Returns
  • true if object is enabled; otherwise, false

public abstract boolean isFocusTraversable ()

Returns whether this object can accept focus or not. Objects that can accept focus will also have the AccessibleState.FOCUSABLE state set in their AccessibleStateSets.

Returns
  • true if object can accept focus; otherwise false

public abstract boolean isShowing ()

Determines if the object is showing. This is determined by checking the visibility of the object and its ancestors. Note: this will return true even if the object is obscured by another (for example, it is underneath a menu that was pulled down).

Returns
  • true if object is showing; otherwise, false

public abstract boolean isVisible ()

Determines if the object is visible. Note: this means that the object intends to be visible; however, it may not be showing on the screen because one of the objects that this object is contained by is currently not visible. To determine if an object is showing on the screen, use isShowing().

Objects that are visible will also have the AccessibleState.VISIBLE state set in their AccessibleStateSets.

Returns
  • true if object is visible; otherwise, false

public abstract void removeFocusListener (FocusListener l)

Removes the specified focus listener so it no longer receives focus events from this component.

Parameters
l the focus listener

public abstract void requestFocus ()

Requests focus for this object. If this object cannot accept focus, nothing will happen. Otherwise, the object will attempt to take focus.

public abstract void setBackground (Color c)

Sets the background color of this object.

Parameters
c the new Color for the background

public abstract void setBounds (Rectangle r)

Sets the bounds of this object in the form of a Rectangle object. The bounds specify this object's width, height, and location relative to its parent.

Parameters
r rectangle indicating this component's bounds
See Also

public abstract void setCursor (Cursor cursor)

Sets the Cursor of this object.

Parameters
cursor the new Cursor for the object
See Also

public abstract void setEnabled (boolean b)

Sets the enabled state of the object.

Parameters
b if true, enables this object; otherwise, disables it
See Also

public abstract void setFont (Font f)

Sets the Font of this object.

Parameters
f the new Font for the object
See Also

public abstract void setForeground (Color c)

Sets the foreground color of this object.

Parameters
c the new Color for the foreground
See Also

public abstract void setLocation (Point p)

Sets the location of the object relative to the parent.

Parameters
p the new position for the top-left corner
See Also

public abstract void setSize (Dimension d)

Resizes this object so that it has width and height.

Parameters
d The dimension specifying the new size of the object.
See Also

public abstract void setVisible (boolean b)

Sets the visible state of the object.

Parameters
b if true, shows this object; otherwise, hides it
See Also