KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > accessibility > AccessibleIcon


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
8 package javax.accessibility;
9
10 /**
11  * The AccessibleIcon interface should be supported by any object
12  * that has an associated icon (e.g., buttons). This interface
13  * provides the standard mechanism for an assistive technology
14  * to get descriptive information about icons.
15  * Applications can determine
16  * if an object supports the AccessibleIcon interface by first
17  * obtaining its AccessibleContext (see
18  * {@link Accessible}) and then calling the
19  * {@link AccessibleContext#getAccessibleIcon} method.
20  * If the return value is not null, the object supports this interface.
21  *
22  * @see Accessible
23  * @see AccessibleContext
24  *
25  * @version 1.3 10/12/99
26  * @author Lynn Monsanto
27  */
28 public interface AccessibleIcon {
29
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 JavaDoc getAccessibleIconDescription();
39     
40     /**
41      * Sets the description of the icon. This is meant to be a brief
42      * textual description of the object. For example, it might be
43      * presented to a blind user to give an indication of the purpose
44      * of the icon.
45      *
46      * @param description the description of the icon
47      */
48     public void setAccessibleIconDescription(String JavaDoc description);
49     
50     /**
51      * Gets the width of the icon
52      *
53      * @return the width of the icon.
54      */
55     public int getAccessibleIconWidth();
56
57     /**
58      * Gets the height of the icon
59      *
60      * @return the height of the icon.
61      */
62     public int getAccessibleIconHeight();
63
64 }
65
Popular Tags