AccessibleIcon (Java SE 15 & JDK 15) (original) (raw)

All Known Implementing Classes:

[ImageIcon.AccessibleImageIcon](../swing/ImageIcon.AccessibleImageIcon.html "class in javax.swing")

public interface AccessibleIcon

The AccessibleIcon interface should be supported by any object that has an associated icon (e.g., buttons). This interface provides the standard mechanism for an assistive technology to get descriptive information about icons. Applications can determine if an object supports theAccessibleIcon interface by first obtaining itsAccessibleContext (see Accessible) and then calling theAccessibleContext.getAccessibleIcon() method. If the return value is not null, the object supports this interface.

Since:

1.3

See Also:

Accessible, AccessibleContext

• Method Summary

• Method Details

  • getAccessibleIconDescription

  String getAccessibleIconDescription()
  Gets the description of the icon. This is meant to be a brief textual description of the object. For example, it might be presented to a blind user to give an indication of the purpose of the icon.
  Returns:
  the description of the icon

  • setAccessibleIconDescription

  void setAccessibleIconDescription​(String description)
  Sets the description of the icon. This is meant to be a brief textual description of the object. For example, it might be presented to a blind user to give an indication of the purpose of the icon.
  Parameters:
  description - the description of the icon

  • getAccessibleIconWidth

  int getAccessibleIconWidth()
  Gets the width of the icon.
  Returns:
  the width of the icon

  • getAccessibleIconHeight

  int getAccessibleIconHeight()
  Gets the height of the icon.
  Returns:
  the height of the icon