JavaTM 2 Platform
Std. Ed. v1.3.1

javax.swing
Class ImageIcon.AccessibleImageIcon

java.lang.Object
  |
  +--javax.accessibility.AccessibleContext
        |
        +--javax.swing.ImageIcon.AccessibleImageIcon
All Implemented Interfaces:
AccessibleIcon, Serializable
Enclosing class:
ImageIcon

protected class ImageIcon.AccessibleImageIcon
extends AccessibleContext
implements AccessibleIcon, Serializable

This class implements accessibility support for the ImageIcon class. It provides an implementation of the Java Accessibility API appropriate to image icon user-interface elements.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. A future release of Swing will provide support for long term persistence.

See Also:
Serialized Form

Fields inherited from class javax.accessibility.AccessibleContext
ACCESSIBLE_ACTION_PROPERTY, ACCESSIBLE_ACTIVE_DESCENDANT_PROPERTY, ACCESSIBLE_CARET_PROPERTY, ACCESSIBLE_CHILD_PROPERTY, ACCESSIBLE_DESCRIPTION_PROPERTY, 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
protected ImageIcon.AccessibleImageIcon()
           
 
Method Summary
 Accessible getAccessibleChild(int i)
          Returns the nth Accessible child of the object.
 int getAccessibleChildrenCount()
          Returns the number of accessible children in the object.
 String getAccessibleIconDescription()
          Gets the description of the icon.
 int getAccessibleIconHeight()
          Gets the height of the icon.
 int getAccessibleIconWidth()
          Gets the width of the icon.
 int getAccessibleIndexInParent()
          Gets the index of this object in its accessible parent.
 Accessible getAccessibleParent()
          Gets the Accessible parent of this object.
 AccessibleRole getAccessibleRole()
          Gets the role of this object.
 AccessibleStateSet getAccessibleStateSet()
          Gets the state of this object.
 Locale getLocale()
          Returns the locale of this object.
 void setAccessibleIconDescription(String description)
          Sets the description of the icon.
 
Methods inherited from class javax.accessibility.AccessibleContext
addPropertyChangeListener, firePropertyChange, getAccessibleAction, getAccessibleComponent, getAccessibleDescription, getAccessibleIcon, getAccessibleName, getAccessibleRelationSet, 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
 

Constructor Detail

ImageIcon.AccessibleImageIcon

protected ImageIcon.AccessibleImageIcon()
Method Detail

getAccessibleRole

public AccessibleRole getAccessibleRole()
Gets the role of this object.
Overrides:
getAccessibleRole in class AccessibleContext
Returns:
an instance of AccessibleRole describing the role of the object
See Also:
AccessibleRole

getAccessibleStateSet

public AccessibleStateSet getAccessibleStateSet()
Gets the state of this object.
Overrides:
getAccessibleStateSet in class AccessibleContext
Returns:
an instance of AccessibleStateSet containing the current state set of the object
See Also:
AccessibleState

getAccessibleParent

public Accessible getAccessibleParent()
Gets the Accessible parent of this object. If the parent of this object implements Accessible, this method should simply return getParent().
Overrides:
getAccessibleParent in class AccessibleContext
Returns:
the Accessible parent of this object -- can be null if this object does not have an Accessible parent

getAccessibleIndexInParent

public int getAccessibleIndexInParent()
Gets the index of this object in its accessible parent.
Overrides:
getAccessibleIndexInParent in class AccessibleContext
Returns:
the index of this object in its parent; -1 if this object does not have an accessible parent.
See Also:
getAccessibleParent()

getAccessibleChildrenCount

public int getAccessibleChildrenCount()
Returns the number of accessible children in the object. If all of the children of this object implement Accessible, than this method should return the number of children of this object.
Overrides:
getAccessibleChildrenCount in class AccessibleContext
Returns:
the number of accessible children in the object.

getAccessibleChild

public Accessible getAccessibleChild(int i)
Returns the nth Accessible child of the object.
Overrides:
getAccessibleChild in class AccessibleContext
Parameters:
i - zero-based index of child
Returns:
the nth Accessible child of the object

getLocale

public Locale getLocale()
                 throws IllegalComponentStateException
Returns the locale of this object.
Overrides:
getLocale in class AccessibleContext
Returns:
the locale of this object

getAccessibleIconDescription

public 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.
Specified by:
getAccessibleIconDescription in interface AccessibleIcon
Returns:
the description of the icon

setAccessibleIconDescription

public 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.
Specified by:
setAccessibleIconDescription in interface AccessibleIcon
Parameters:
description - the description of the icon

getAccessibleIconHeight

public int getAccessibleIconHeight()
Gets the height of the icon.
Specified by:
getAccessibleIconHeight in interface AccessibleIcon
Returns:
the height of the icon

getAccessibleIconWidth

public int getAccessibleIconWidth()
Gets the width of the icon.
Specified by:
getAccessibleIconWidth in interface AccessibleIcon
Returns:
the width of the icon

JavaTM 2 Platform
Std. Ed. v1.3.1

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

Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2001 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.