1. /*
  2. * @(#)AccessibleIcon.java 1.8 03/12/19
  3. *
  4. * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
  5. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
  6. */
  7. package javax.accessibility;
  8. /**
  9. * The AccessibleIcon interface should be supported by any object
  10. * that has an associated icon (e.g., buttons). This interface
  11. * provides the standard mechanism for an assistive technology
  12. * to get descriptive information about icons.
  13. * Applications can determine
  14. * if an object supports the AccessibleIcon interface by first
  15. * obtaining its AccessibleContext (see
  16. * {@link Accessible}) and then calling the
  17. * {@link AccessibleContext#getAccessibleIcon} method.
  18. * If the return value is not null, the object supports this interface.
  19. *
  20. * @see Accessible
  21. * @see AccessibleContext
  22. *
  23. * @version 1.3 10/12/99
  24. * @author Lynn Monsanto
  25. */
  26. public interface AccessibleIcon {
  27. /**
  28. * Gets the description of the icon. This is meant to be a brief
  29. * textual description of the object. For example, it might be
  30. * presented to a blind user to give an indication of the purpose
  31. * of the icon.
  32. *
  33. * @return the description of the icon
  34. */
  35. public String getAccessibleIconDescription();
  36. /**
  37. * Sets the description of the icon. This is meant to be a brief
  38. * textual description of the object. For example, it might be
  39. * presented to a blind user to give an indication of the purpose
  40. * of the icon.
  41. *
  42. * @param description the description of the icon
  43. */
  44. public void setAccessibleIconDescription(String description);
  45. /**
  46. * Gets the width of the icon
  47. *
  48. * @return the width of the icon.
  49. */
  50. public int getAccessibleIconWidth();
  51. /**
  52. * Gets the height of the icon
  53. *
  54. * @return the height of the icon.
  55. */
  56. public int getAccessibleIconHeight();
  57. }