javax.accessibility
Interface AccessibleIcon

All Known Implementing Classes:
ImageIcon.AccessibleImageIcon sample code for javax.swing.ImageIcon.AccessibleImageIcon definition code for javax.swing.ImageIcon.AccessibleImageIcon

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 the AccessibleIcon interface by first obtaining its AccessibleContext (see Accessible sample code for javax.accessibility.Accessible definition code for javax.accessibility.Accessible ) and then calling the AccessibleContext.getAccessibleIcon() sample code for javax.accessibility.AccessibleContext.getAccessibleIcon() definition code for javax.accessibility.AccessibleContext.getAccessibleIcon() method. If the return value is not null, the object supports this interface.

See Also:
Accessible sample code for javax.accessibility.Accessible definition code for javax.accessibility.Accessible , AccessibleContext sample code for javax.accessibility.AccessibleContext definition code for javax.accessibility.AccessibleContext

Method Summary
 String sample code for java.lang.String definition code for java.lang.String getAccessibleIconDescription sample code for javax.accessibility.AccessibleIcon.getAccessibleIconDescription() definition code for javax.accessibility.AccessibleIcon.getAccessibleIconDescription() ()
          Gets the description of the icon.
 int getAccessibleIconHeight sample code for javax.accessibility.AccessibleIcon.getAccessibleIconHeight() definition code for javax.accessibility.AccessibleIcon.getAccessibleIconHeight() ()
          Gets the height of the icon
 int getAccessibleIconWidth sample code for javax.accessibility.AccessibleIcon.getAccessibleIconWidth() definition code for javax.accessibility.AccessibleIcon.getAccessibleIconWidth() ()
          Gets the width of the icon
 void setAccessibleIconDescription sample code for javax.accessibility.AccessibleIcon.setAccessibleIconDescription(java.lang.String) definition code for javax.accessibility.AccessibleIcon.setAccessibleIconDescription(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  description)
          Sets the description of the icon.
 

Method Detail

getAccessibleIconDescription sample code for javax.accessibility.AccessibleIcon.getAccessibleIconDescription() definition code for javax.accessibility.AccessibleIcon.getAccessibleIconDescription()

String sample code for java.lang.String definition code for java.lang.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 sample code for javax.accessibility.AccessibleIcon.setAccessibleIconDescription(java.lang.String) definition code for javax.accessibility.AccessibleIcon.setAccessibleIconDescription(java.lang.String)

void setAccessibleIconDescription(String sample code for java.lang.String definition code for java.lang.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 sample code for javax.accessibility.AccessibleIcon.getAccessibleIconWidth() definition code for javax.accessibility.AccessibleIcon.getAccessibleIconWidth()

int getAccessibleIconWidth()
Gets the width of the icon

Returns:
the width of the icon.

getAccessibleIconHeight sample code for javax.accessibility.AccessibleIcon.getAccessibleIconHeight() definition code for javax.accessibility.AccessibleIcon.getAccessibleIconHeight()

int getAccessibleIconHeight()
Gets the height of the icon

Returns:
the height of the icon.