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