javax.swing.text.html
Class AccessibleHTML.HTMLAccessibleContext

java.lang.Object
  javax.accessibility.AccessibleContext
      javax.swing.text.html.AccessibleHTML.HTMLAccessibleContext

All Implemented Interfaces:

javax.accessibility.Accessible, javax.accessibility.AccessibleComponent

Direct Known Subclasses:

AccessibleHTML.IconElementInfo.IconAccessibleContext, AccessibleHTML.RootHTMLAccessibleContext, AccessibleHTML.TableElementInfo.TableAccessibleContext, AccessibleHTML.TextElementInfo.TextAccessibleContext

Enclosing class:

AccessibleHTML

protected abstract class AccessibleHTML.HTMLAccessibleContext

extends javax.accessibility.AccessibleContext

implements javax.accessibility.Accessible, javax.accessibility.AccessibleComponent

Field Summary

protected AccessibleHTML.ElementInfo

elementInfo

Fields inherited from class javax.accessibility.AccessibleContext

ACCESSIBLE_ACTION_PROPERTY, ACCESSIBLE_ACTIVE_DESCENDANT_PROPERTY, ACCESSIBLE_CARET_PROPERTY, ACCESSIBLE_CHILD_PROPERTY, ACCESSIBLE_DESCRIPTION_PROPERTY, ACCESSIBLE_HYPERTEXT_OFFSET, ACCESSIBLE_NAME_PROPERTY, ACCESSIBLE_SELECTION_PROPERTY, ACCESSIBLE_STATE_PROPERTY, ACCESSIBLE_TABLE_CAPTION_CHANGED, ACCESSIBLE_TABLE_COLUMN_DESCRIPTION_CHANGED, ACCESSIBLE_TABLE_COLUMN_HEADER_CHANGED, ACCESSIBLE_TABLE_MODEL_CHANGED, ACCESSIBLE_TABLE_ROW_DESCRIPTION_CHANGED, ACCESSIBLE_TABLE_ROW_HEADER_CHANGED, ACCESSIBLE_TABLE_SUMMARY_CHANGED, ACCESSIBLE_TEXT_PROPERTY, ACCESSIBLE_VALUE_PROPERTY, ACCESSIBLE_VISIBLE_DATA_PROPERTY, accessibleDescription, accessibleName, accessibleParent

Constructor Summary

AccessibleHTML.HTMLAccessibleContext(AccessibleHTML.ElementInfo elementInfo)

Method Summary

void	addFocusListener(FocusListener l) Adds the specified focus listener to receive focus events from this component.
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.
javax.accessibility.Accessible	getAccessibleAt(Point p) Returns the Accessible child, if one exists, contained at the local coordinate Point.
javax.accessibility.Accessible	getAccessibleChild(int i) Returns the specified Accessible child of the object.
int	getAccessibleChildrenCount() Returns the number of accessible children of the object.
javax.accessibility.AccessibleComponent	getAccessibleComponent()
javax.accessibility.AccessibleContext	getAccessibleContext()
int	getAccessibleIndexInParent() Gets the 0-based index of this object in its accessible parent.
javax.accessibility.AccessibleStateSet	getAccessibleStateSet() Gets the state set of this object.
Color	getBackground() Gets the background color of this object.
Rectangle	getBounds() Gets the bounds of this object in the form of a Rectangle object.
Cursor	getCursor() Gets the Cursor of this object.
private AccessibleHTML.ElementInfo	getElementInfoAt(AccessibleHTML.ElementInfo elementInfo, Point p)
Font	getFont() Gets the Font of this object.
FontMetrics	getFontMetrics(Font f) Gets the FontMetrics of this object.
Color	getForeground() Gets the foreground color of this object.
Locale	getLocale() Gets the locale of the component.
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.
Point	getLocationOnScreen() Returns the location of the object on the screen.
Dimension	getSize() Returns the size of this object in the form of a Dimension object.
boolean	isEnabled() Determines if the object is enabled.
boolean	isFocusTraversable() Returns whether this object can accept focus or not.
boolean	isShowing() Determines if the object is showing.
boolean	isVisible() Determines if the object is visible.
void	removeFocusListener(FocusListener l) Removes the specified focus listener so it no longer receives focus events from this component.
void	requestFocus() Requests focus for this object.
void	setBackground(Color c) Sets the background color of this object.
void	setBounds(Rectangle r) Sets the bounds of this object in the form of a Rectangle object.
void	setCursor(Cursor cursor) Sets the Cursor of this object.
void	setEnabled(boolean b) Sets the enabled state of the object.
void	setFont(Font f) Sets the Font of this object.
void	setForeground(Color c) Sets the foreground color of this object.
void	setLocation(Point p) Sets the location of the object relative to the parent.
void	setSize(Dimension d) Resizes this object so that it has width and height.
void	setVisible(boolean b) Sets the visible state of the object.

Methods inherited from class javax.accessibility.AccessibleContext

addPropertyChangeListener, firePropertyChange, getAccessibleAction, getAccessibleDescription, getAccessibleEditableText, getAccessibleIcon, getAccessibleName, getAccessibleParent, getAccessibleRelationSet, getAccessibleRole, getAccessibleSelection, getAccessibleTable, getAccessibleText, getAccessibleValue, removePropertyChangeListener, setAccessibleDescription, setAccessibleName, setAccessibleParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

elementInfo

protected AccessibleHTML.ElementInfo elementInfo

Constructor Detail

AccessibleHTML.HTMLAccessibleContext

public AccessibleHTML.HTMLAccessibleContext(AccessibleHTML.ElementInfo elementInfo)

Method Detail

getAccessibleContext

public javax.accessibility.AccessibleContext getAccessibleContext()

Specified by:

getAccessibleContext in interface javax.accessibility.Accessible

getAccessibleStateSet

public javax.accessibility.AccessibleStateSet getAccessibleStateSet()

Gets the state set of this object.

Returns:

an instance of AccessibleStateSet describing the states of the object

See Also:

AccessibleStateSet

getAccessibleIndexInParent

public int getAccessibleIndexInParent()

Gets the 0-based index of this object in its accessible parent.

Returns:

the 0-based index of this object in its parent; -1 if this object does not have an accessible parent.

See Also:

AccessibleContext.getAccessibleParent(), getAccessibleChildrenCount(), getAccessibleChild(int)

getAccessibleChildrenCount

public int getAccessibleChildrenCount()

Returns the number of accessible children of the object.

Returns:

the number of accessible children of the object.

getAccessibleChild

public javax.accessibility.Accessible getAccessibleChild(int i)

Returns the specified Accessible child of the object. The Accessible children of an Accessible object are zero-based, so the first child of an Accessible child is at index 0, the second child is at index 1, and so on.

Parameters:

i - zero-based index of child

Returns:

the Accessible child of the object

See Also:

getAccessibleChildrenCount()

getLocale

public Locale getLocale()
                 throws IllegalComponentStateException

Gets the locale of the component. If the component does not have a locale, then the locale of its parent is returned.

Returns:

this component's locale. If this component does not have a locale, the locale of its parent is returned.

Throws:

IllegalComponentStateException - If the Component does not have its own locale and has not yet been added to a containment hierarchy such that the locale can be determined from the containing parent.

getAccessibleComponent

public javax.accessibility.AccessibleComponent getAccessibleComponent()

getBackground

public Color getBackground()

Gets the background color of this object.

Specified by:

getBackground in interface javax.accessibility.AccessibleComponent

Returns:

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

See Also:

setBackground(java.awt.Color)

setBackground

public void setBackground(Color c)

Sets the background color of this object.

Specified by:

setBackground in interface javax.accessibility.AccessibleComponent

Parameters:

c - the new Color for the background

See Also:

setBackground(java.awt.Color)

getForeground

public Color getForeground()

Gets the foreground color of this object.

Specified by:

getForeground in interface javax.accessibility.AccessibleComponent

Returns:

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

See Also:

setForeground(java.awt.Color)

setForeground

public void setForeground(Color c)

Sets the foreground color of this object.

Specified by:

setForeground in interface javax.accessibility.AccessibleComponent

Parameters:

c - the new Color for the foreground

See Also:

getForeground()

getCursor

public Cursor getCursor()

Gets the Cursor of this object.

Specified by:

getCursor in interface javax.accessibility.AccessibleComponent

Returns:

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

See Also:

setCursor(java.awt.Cursor)

setCursor

public void setCursor(Cursor cursor)

Sets the Cursor of this object.

Specified by:

setCursor in interface javax.accessibility.AccessibleComponent

See Also:

getCursor()

getFont

public Font getFont()

Gets the Font of this object.

Specified by:

getFont in interface javax.accessibility.AccessibleComponent

Returns:

the Font,if supported, for the object; otherwise, null

See Also:

setFont(java.awt.Font)

setFont

public void setFont(Font f)

Sets the Font of this object.

Specified by:

setFont in interface javax.accessibility.AccessibleComponent

Parameters:

f - the new Font for the object

See Also:

getFont()

getFontMetrics

public FontMetrics getFontMetrics(Font f)

Gets the FontMetrics of this object.

Specified by:

getFontMetrics in interface javax.accessibility.AccessibleComponent

Parameters:

f - the Font

Returns:

the FontMetrics, if supported, the object; otherwise, null

See Also:

getFont()

isEnabled

public boolean isEnabled()

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

Specified by:

isEnabled in interface javax.accessibility.AccessibleComponent

Returns:

true if object is enabled; otherwise, false

See Also:

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

setEnabled

public void setEnabled(boolean b)

Sets the enabled state of the object.

Specified by:

setEnabled in interface javax.accessibility.AccessibleComponent

Parameters:

b - if true, enables this object; otherwise, disables it

See Also:

isEnabled()

isVisible

public 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.

Specified by:

isVisible in interface javax.accessibility.AccessibleComponent

Returns:

true if object is visible; otherwise, false

See Also:

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

setVisible

public void setVisible(boolean b)

Sets the visible state of the object.

Specified by:

setVisible in interface javax.accessibility.AccessibleComponent

Parameters:

b - if true, shows this object; otherwise, hides it

See Also:

isVisible()

isShowing

public 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).

Specified by:

isShowing in interface javax.accessibility.AccessibleComponent

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's x and y coordinates are defined to be relative to the coordinate system of the object.

Specified by:

contains in interface javax.accessibility.AccessibleComponent

Parameters:

p - the Point relative to the coordinate system of the object

Returns:

true if object contains Point; otherwise false

See Also:

getBounds()

getLocationOnScreen

public Point getLocationOnScreen()

Returns the location of the object on the screen.

Specified by:

getLocationOnScreen in interface javax.accessibility.AccessibleComponent

Returns:

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

See Also:

getBounds(), getLocation()

getLocation

public 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.

Specified by:

getLocation in interface javax.accessibility.AccessibleComponent

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

See Also:

getBounds(), getLocationOnScreen()

setLocation

public void setLocation(Point p)

Sets the location of the object relative to the parent.

Specified by:

setLocation in interface javax.accessibility.AccessibleComponent

Parameters:

p - the new position for the top-left corner

See Also:

getLocation()

getBounds

public 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.

Specified by:

getBounds in interface javax.accessibility.AccessibleComponent

Returns:

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

See Also:

contains(java.awt.Point)

setBounds

public 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.

Specified by:

setBounds in interface javax.accessibility.AccessibleComponent

Parameters:

r - rectangle indicating this component's bounds

See Also:

getBounds()

getSize

public 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.

Specified by:

getSize in interface javax.accessibility.AccessibleComponent

Returns:

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

See Also:

setSize(java.awt.Dimension)

setSize

public void setSize(Dimension d)

Resizes this object so that it has width and height.

Specified by:

setSize in interface javax.accessibility.AccessibleComponent

Parameters:

d - The dimension specifying the new size of the object.

See Also:

getSize()

getAccessibleAt

public javax.accessibility.Accessible getAccessibleAt(Point p)

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

Specified by:

getAccessibleAt in interface javax.accessibility.AccessibleComponent

Parameters:

p - The point relative to the coordinate system of this object.

Returns:

the Accessible, if it exists, at the specified location; otherwise null

getElementInfoAt

private AccessibleHTML.ElementInfo getElementInfoAt(AccessibleHTML.ElementInfo elementInfo,
                                                    Point p)

isFocusTraversable

public 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.

Specified by:

isFocusTraversable in interface javax.accessibility.AccessibleComponent

Returns:

true if object can accept focus; otherwise false

See Also:

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

requestFocus

public void requestFocus()

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

Specified by:

requestFocus in interface javax.accessibility.AccessibleComponent

See Also:

isFocusTraversable()

addFocusListener

public void addFocusListener(FocusListener l)

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

Specified by:

addFocusListener in interface javax.accessibility.AccessibleComponent

Parameters:

l - the focus listener

See Also:

removeFocusListener(java.awt.event.FocusListener)

removeFocusListener

public void removeFocusListener(FocusListener l)

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

Specified by:

removeFocusListener in interface javax.accessibility.AccessibleComponent

Parameters:

l - the focus listener

See Also:

addFocusListener(java.awt.event.FocusListener)