All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.sun.java.accessibility.Accessible

public interface Accessible

Interface Accessible is a set of methods that can be implemented by user interface classes to make them more accessible. An assistive technology can check if an object implements the Accessible interface by using the 'instanceof' operator.

addAccessibleSelection(int)

Adds the nth selected item in the object to the object's selection.

addFocusListener(FocusListener)

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

clearAccessibleSelection()

Clears the selection in the object, so that nothing in the object is selected.

contains(Point)

Checks whether the specified Point is within this object's bounds, where the Point is relative to the coordinate system of the object.

doAccessibleAction(int)

Perform the nth Action on the object

getAccessibleActionCount()

Returns the number of items Actions available in this object If there is more than one, the first one is the "default" action (if any action is considered "default").

getAccessibleActionDescription(int)

Return a description of the nth action of the object.

getAccessibleAt(Point)

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

getAccessibleChild(int)

Return the nth Accessible child of the object.

getAccessibleChildrenCount()

Returns the number of accessible children in the object.

getAccessibleDescription()

Get the accessible description of this object.

getAccessibleName()

Get the accessible name of this object.

getAccessibleParent()

Get the Accessible parent of this object.

getAccessibleRole()

Get the role of this object.

getAccessibleSelection(int)

Returns an Accessible representing the nth selected item in the object.

getAccessibleSelectionCount()

Returns the number of items currently selected.

getAccessibleStateSet()

Get the state set of this object.

getAccessibleText()

Gets the AccessibleText interface for the component.

getAccessibleValue()

Get the value of this object as a String.

getBackground()

Get the background color of this object.

getBounds()

Returns the current bounds of this object

getCursor()

Get the Cursor of this object.

getFont()

Get the Font of this object.

getFontMetrics(Font)

Get the FontMetrics of this object.

getForeground()

Get the foreground color of this object.

getLocale()

Gets the locale of the component.

getLocation()

Returns the location of the object relative to parent.

getLocationOnScreen()

Returns the location of the object on the screen.

getNextAccessibleSibling()

Get the next sibling of this Accessible, if a preferred one exists.

getPreviousAccessibleSibling()

Get the previous sibling of this Accessible, if a preferred one exists.

getSize()

Returns the current size of this object

isEnabled()

Determine if the object is enabled.

isFocusTraversable()

Returns whether this object can accept focus or not.

isShowing()

Determine if the object is showing.

isVisible()

Determine if the object is visible.

removeAccessibleSelection(int)

Removes the nth selected item in the object from the object's selection.

removeFocusListener(FocusListener)

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

requestFocus()

Requests focus for this object.

selectAllAccessibleSelection()

Causes every selected item in the object to be selected, if the object supports multiple selections (if getAccessibleStateSet returns a state that is MULTISELECTABLE).

setAccessibleDescription(String)

Set the accessible description of this object.

setAccessibleName(String)

Set the localized accessible name of this object.

setBackground(Color)

Set the background color of this object.

setBounds(Rectangle)

Sets the current bounds of this object

setCursor(Cursor)

Set the Cursor of this object.

setEnabled(boolean)

Set the enabled state of the object.

setFont(Font)

Set the Font of this object.

setForeground(Color)

Set the foreground color of this object.

setLocale(Locale)

Sets the locale of the component.

setLocation(Point)

Sets the location of the object relative to parent.

setSize(Dimension)

Sets the current size of this object

setVisible(boolean)

Set the visible state of the object.

 public abstract Accessible getNextAccessibleSibling()

Get the next sibling of this Accessible, if a preferred one exists.

Returns:

the next Accessible, if there is one

 public abstract Accessible getPreviousAccessibleSibling()

Get the previous sibling of this Accessible, if a preferred one exists.

Returns:

the previous Accessible, if there is one

 public abstract Color getBackground()

Get the background color of this object.

Returns:

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

 public abstract void setBackground(Color c)

Set the background color of this object.

Parameters:

c - the new Color for the background

 public abstract Color getForeground()

Get the foreground color of this object.

Returns:

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

 public abstract void setForeground(Color c)

Set the foreground color of this object.

Parameters:

c - the new Color for the foreground

 public abstract Cursor getCursor()

Get the Cursor of this object.

Returns:

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

 public abstract void setCursor(Cursor cursor)

Set the Cursor of this object.

Parameters:

c - the new Cursor for the object

 public abstract Font getFont()

Get the Font of this object.

Returns:

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

 public abstract void setFont(Font f)

Set the Font of this object.

Parameters:

f - the new Font for the object

 public abstract FontMetrics getFontMetrics(Font f)

Get the FontMetrics of this object.

Parameters:

f - the Font

Returns:

if supported, the FontMetrics the object; otherwise, null

See Also:

getFont

 public abstract boolean isEnabled()

Determine if the object is enabled.

Returns:

true if object is enabled; otherwise, false

 public abstract void setEnabled(boolean b)

Set the enabled state of the object.

Parameters:

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

 public abstract boolean isVisible()

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

Returns:

true if object is visible; otherwise, false

 public abstract void setVisible(boolean b)

Set the visible state of the object.

Parameters:

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

 public abstract boolean isShowing()

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

Returns:

true if object is showing; otherwise, false

 public abstract boolean contains(Point p)

Checks whether the specified Point is within this object's bounds, where the Point is 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

 public abstract Point getLocationOnScreen()

Returns the location of the object on the screen.

Returns:

location of object on screen -- can be null if this object is not on the screen

 public abstract Point getLocation()

Returns the location of the object relative to parent.

Returns:

location of object relative to parent -- can be null if this object or its parent are not on the screen

 public abstract void setLocation(Point p)

Sets the location of the object relative to parent.

 public abstract Rectangle getBounds()

Returns the current bounds of this object

Returns:

current bounds of object -- can be null if this object is not on the screen

 public abstract void setBounds(Rectangle r)

Sets the current bounds of this object

 public abstract Dimension getSize()

Returns the current size of this object

Returns:

current size of object -- can be null if this object is not on the screen

 public abstract void setSize(Dimension d)

Sets the current size of this object

 public abstract Accessible getAccessibleAt(Point p)

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

Returns:

the Accessible at the specified location, if it exists

 public abstract boolean isFocusTraversable()

Returns whether this object can accept focus or not.

Returns:

true if object can accept focus; otherwise false

 public abstract void requestFocus()

Requests focus for this object.

 public abstract String getAccessibleName()

Get the accessible name of this object.

Returns:

the localized name of the object -- can be null if this object does not have a name

 public abstract void setAccessibleName(String s)

Set the localized accessible name of this object.

Parameters:

s - the new localized name of the object.

 public abstract String getAccessibleDescription()

Get the accessible description of this object.

Returns:

the localized description of the object -- can be null if this object does not have a description

 public abstract void setAccessibleDescription(String s)

Set the accessible description of this object.

Parameters:

s - the new localized description of the object

 public abstract AccessibleStateSet getAccessibleStateSet()

Get the state set of this object.

Returns:

an instance of AccessibleStateSet containing the current state set of the object

See Also:

AccessibleState

 public abstract AccessibleRole getAccessibleRole()

Get the role of this object.

Returns:

an instance of AccessibleRole describing the role of the object

See Also:

AccessibleRole

 public abstract String getAccessibleValue()

Get the value of this object as a String.

Returns:

human readable value of the object -- can be null if this object does not have a value

 public abstract Accessible getAccessibleParent()

Get the Accessible parent of this object.

Returns:

the Accessible parent of this object -- can be null if this object does not have an Accessible parent

 public abstract int getAccessibleChildrenCount()

Returns the number of accessible children in the object.

Returns:

the number of accessible children in the object.

 public abstract Accessible getAccessibleChild(int i)

Return the nth Accessible child of the object.

Parameters:

i - zero-based index of child

Returns:

the nth Accessible child of the object

 public abstract int getAccessibleActionCount()

Returns the number of items Actions available in this object If there is more than one, the first one is the "default" action (if any action is considered "default").

Returns:

the number of Actions in this object

 public abstract String getAccessibleActionDescription(int i)

Return a description of the nth action of the object.

Parameters:

i - zero-based index of the actions

Returns:

a description of the nth action

 public abstract boolean doAccessibleAction(int i)

Perform the nth Action on the object

Parameters:

i - zero-based index of actions

Returns:

whether the action was performed or not.

 public abstract Locale getLocale() throws IllegalComponentStateException

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

Returns:

the Locale of the object.

See Also:

setLocale

 public abstract void setLocale(Locale l)

Sets the locale of the component.

Parameters:

l - the new Locale of the object.

See Also:

getLocale

 public abstract AccessibleText getAccessibleText()

Gets the AccessibleText interface for the component. If the component does not speak AccessibleText, or have a proxy which does, this method returns null.

Returns:

the AccessibleText of the object.

See Also:

AccessibleText

 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 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 int getAccessibleSelectionCount()

Returns the number of items currently selected. If no items are selected, the return value will be 0.

Returns:

the number of items currently selected.

 public abstract Accessible getAccessibleSelection(int i)

Returns an Accessible representing the nth selected item in the object. If there isn't a selection, or there are fewer items selcted than the integer passed in, the return value will be null.

Parameters:

i - the zero-based index of selected items

Returns:

an Accessible containing the selected item

 public abstract void addAccessibleSelection(int i)

Adds the nth selected item in the object to the object's selection. If the object supports multiple selections, (the method getAccessibleStateSet returns a state that is MULTISELECTABLE) the nth item is added to any existing selection, otherwse it replaces any existing selection in the objct. If the nth item is already selected, this method has no effect.

Parameters:

i - the zero-based index of selectable items

See Also:

getAccessibleStateSet

 public abstract void removeAccessibleSelection(int i)

Removes the nth selected item in the object from the object's selection. If the nth item isn't currently selected, this method has no effect.

Parameters:

i - the zero-based index of selectable items

 public abstract void clearAccessibleSelection()

Clears the selection in the object, so that nothing in the object is selected.

 public abstract void selectAllAccessibleSelection()

Causes every selected item in the object to be selected, if the object supports multiple selections (if getAccessibleStateSet returns a state that is MULTISELECTABLE).

See Also:

getAccessibleStateSet

All Packages  Class Hierarchy  This Package  Previous  Next  Index