javax.accessibility

Interface AccessibleComponent

All Known Subinterfaces:

AccessibleExtendedComponent

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

See Also:

Accessible, AccessibleContext, AccessibleContext.getAccessibleComponent()

Method Summary

Methods

Modifier and Type	Method and Description
void	addFocusListener(java.awt.event.FocusListener listener) Adds the specified listener to this component.
boolean	contains(java.awt.Point point) Tests whether or not the specified point is contained within this component.
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.
java.awt.Color	getBackground() Get the background color of this component.
java.awt.Rectangle	getBounds() Get the bounds of this component relative to its parent - it's width, height, and relative location to its parent.
java.awt.Cursor	getCursor() Get the cursor of this component.
java.awt.Font	getFont() Get the font of this component
java.awt.FontMetrics	getFontMetrics(java.awt.Font font) Get the FontMetrics of the specified font in this component.
java.awt.Color	getForeground() Get the foreground color of this component.
java.awt.Point	getLocation() Get the location of this component in the parent's coordinate system.
java.awt.Point	getLocationOnScreen() Get the location of this component in the screen's coordinate space.
java.awt.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(java.awt.event.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(java.awt.Color color) Set the background color of this component to the specified color.
void	setBounds(java.awt.Rectangle rectangle) Set the bounds of this component to the specified height and width, and relative location to its parent.
void	setCursor(java.awt.Cursor cursor) Set the cursor of the component.
void	setEnabled(boolean b) Set this component to an enabled or disabled state.
void	setFont(java.awt.Font font) Set the font of this component.
void	setForeground(java.awt.Color color) Set the foreground color of this component.
void	setLocation(java.awt.Point point) Set the location of this component relative to its parent.
void	setSize(java.awt.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

getBackground

java.awt.Color getBackground()

Get the background color of this component.

Returns:

the background color of this component, or null if not supported

See Also:

setBackground(Color)

setBackground

void setBackground(java.awt.Color color)

Set the background color of this component to the specified color.

Parameters:

color - the color to set the background to

See Also:

getBackground()

getForeground

java.awt.Color getForeground()

Get the foreground color of this component.

Returns:

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

See Also:

setForeground(Color)

setForeground

void setForeground(java.awt.Color color)

Set the foreground color of this component.

Parameters:

color - the color to set the foreground to

See Also:

getForeground()

getCursor

java.awt.Cursor getCursor()

Get the cursor of this component.

Returns:

the Cursor of this component, or null if not supported

See Also:

setCursor(Cursor)

setCursor

void setCursor(java.awt.Cursor cursor)

Set the cursor of the component.

Parameters:

cursor - the graphical representation of the cursor to use

See Also:

getCursor()

getFont

java.awt.Font getFont()

Get the font of this component

Returns:

the font of the component, or null if not supported

See Also:

setFont(Font)

setFont

void setFont(java.awt.Font font)

Set the font of this component.

Parameters:

font - the font to use

See Also:

getFont()

getFontMetrics

java.awt.FontMetrics getFontMetrics(java.awt.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:

java.lang.NullPointerException - if font is null

See Also:

getFont()

isEnabled

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:

setEnabled(boolean), AccessibleContext.getAccessibleStateSet(), AccessibleState.ENABLED

setEnabled

void setEnabled(boolean b)

Set this component to an enabled or disabled state.

Parameters:

b - true to enable the component, else disable it

See Also:

isEnabled()

isVisible

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:

setVisible(boolean), AccessibleContext.getAccessibleStateSet(), AccessibleState.VISIBLE

setVisible

void setVisible(boolean b)

Set the visible state of this component.

Parameters:

b - true to make the component visible, else hide it

See Also:

isVisible()

isShowing

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(), setVisible(boolean), AccessibleContext.getAccessibleStateSet(), AccessibleState.SHOWING

contains

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:

point - the Point to locate

Returns:

true if the point is within this component

Throws:

java.lang.NullPointerException - if point is null

See Also:

getBounds()

getLocationOnScreen

java.awt.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:

getBounds(), getLocation()

getLocation

java.awt.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:

getBounds(), getLocationOnScreen(), setLocation(Point)

setLocation

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:

point - the top-left corner of this component relative to the parent

Throws:

java.lang.NullPointerException - if point is null

See Also:

getLocation()

getBounds

java.awt.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:

contains(Point)

setBounds

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:

rectangle - the new height, width, and relative location

Throws:

java.lang.NullPointerException - if rectangle is null

getSize

java.awt.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:

setSize(Dimension)

setSize

void setSize(java.awt.Dimension dimension)

Set the size of this component to the given dimensions.

Parameters:

dimension - the new size of the component

Throws:

java.lang.NullPointerException - if dimension is null

See Also:

getSize()

getAccessibleAt

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:

point - the location within this component's coordinate system

Returns:

the accessible child object at that point, or null

isFocusTraversable

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:

AccessibleContext.getAccessibleStateSet(), AccessibleState.FOCUSABLE, AccessibleState.FOCUSED

requestFocus

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:

isFocusTraversable(), AccessibleState.FOCUSED

addFocusListener

void addFocusListener(java.awt.event.FocusListener listener)

Adds the specified listener to this component.

Parameters:

listener - the listener to add to this component

See Also:

removeFocusListener(FocusListener)

removeFocusListener

void removeFocusListener(java.awt.event.FocusListener listener)

Removes the specified listener from this component.

Parameters:

listener - the listener to remove

See Also:

addFocusListener(FocusListener)