javax.accessibility

Interface 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: 1.2

UNKNOWN: updated to 1.4

Method Summary
void	addFocusListener(FocusListener listener) Adds the specified listener to this component.
boolean	contains(Point point) Tests whether or not the specified point is contained within this component.
Accessible	getAccessibleAt(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.
Color	getBackground() Get the background color of this component.
Rectangle	getBounds() Get the bounds of this component relative to its parent - it's width, height, and relative location to its parent.
Cursor	getCursor() Get the cursor of this component.
Font	getFont() Get the font of this component
FontMetrics	getFontMetrics(Font font) Get the `FontMetrics` of the specified font in this component.
Color	getForeground() Get the foreground color of this component.
Point	getLocation() Get the location of this component in the parent's coordinate system.
Point	getLocationOnScreen() Get the location of this component in the screen's coordinate space.
Dimension	getSize() Get the size of this component - it's width and height.
boolean	isEnabled() Indicates whether or not this component is enabled.
boolean	isFocusTraversable() Indicates whether or not this component can accept focus.
boolean	isShowing() Indicates whether or not this component is visible by checking the visibility of this component and its ancestors.
boolean	isVisible() Indicates whether or not this component is visible or intends to be visible although one of its ancestors may not be.
void	removeFocusListener(FocusListener listener) Removes the specified listener from this component.
void	requestFocus() If this method is called this component will attempt to gain focus, but if it cannot accept focus nothing happens.
void	setBackground(Color color) Set the background color of this component to the specified color.
void	setBounds(Rectangle rectangle) Set the bounds of this component to the specified height and width, and relative location to its parent.
void	setCursor(Cursor cursor) Set the cursor of the component.
void	setEnabled(boolean b) Set this component to an enabled or disabled state.
void	setFont(Font font) Set the font of this component.
void	setForeground(Color color) Set the foreground color of this component.
void	setLocation(Point point) Set the location of this component relative to its parent.
void	setSize(Dimension dimension) Set the size of this component to the given dimensions.
void	setVisible(boolean b) Set the visible state of this component.

Method Detail

addFocusListener

public void addFocusListener(FocusListener listener)

Adds the specified listener to this component.

Parameters: listener the listener to add to this component

contains

public boolean contains(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: point the Point to locate

Returns: true if the point is within this component

Throws: NullPointerException if point is null

getAccessibleAt

public Accessible getAccessibleAt(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: point the location within this component's coordinate system

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

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

getCursor

public Cursor getCursor()

Get the cursor of this component.

Returns: the Cursor of this component, or null if not supported

getFont

public Font getFont()

Get the font of this component

Returns: the font of the component, or null if not supported

getFontMetrics

public FontMetrics getFontMetrics(Font font)

Get the FontMetrics of the specified font in this component.

Parameters: font the specified font

Returns: the metrics for the specified font, or null if not supported

Throws: NullPointerException if font is null

getForeground

public Color getForeground()

Get the foreground color of this component.

Returns: the foreground color of this component, or null if not supported

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

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

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

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

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

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

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

removeFocusListener

public void removeFocusListener(FocusListener listener)

Removes the specified listener from this component.

Parameters: listener the listener to remove

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