Java™ Platform
Standard Ed. 6

javax.accessibility
Interface AccessibleIcon

All Known Implementing Classes:
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) and then calling the AccessibleContext.getAccessibleIcon() method. If the return value is not null, the object supports this interface.

Since:
1.3
See Also:
Accessible, AccessibleContext

Method Summary
 String getAccessibleIconDescription()
          Gets the description of the icon.
 int getAccessibleIconHeight()
          Gets the height of the icon
 int getAccessibleIconWidth()
          Gets the width of the icon
 void setAccessibleIconDescription(String description)
          Sets the description of the icon.
 

Method Detail

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.

Java™ Platform
Standard Ed. 6

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.

Scripting on this page tracks web page traffic, but does not change the content in any way.