1 /*
2 * Copyright 1999-2006 Sun Microsystems, Inc. All Rights Reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package javax.accessibility;
27
28 /**
29 * The AccessibleIcon interface should be supported by any object
30 * that has an associated icon (e.g., buttons). This interface
31 * provides the standard mechanism for an assistive technology
32 * to get descriptive information about icons.
33 * Applications can determine
34 * if an object supports the AccessibleIcon interface by first
35 * obtaining its AccessibleContext (see
36 * {@link Accessible}) and then calling the
37 * {@link AccessibleContext#getAccessibleIcon} method.
38 * If the return value is not null, the object supports this interface.
39 *
40 * @see Accessible
41 * @see AccessibleContext
42 *
43 * @author Lynn Monsanto
44 * @since 1.3
45 */
46 public interface AccessibleIcon {
47
48 /**
49 * Gets the description of the icon. This is meant to be a brief
50 * textual description of the object. For example, it might be
51 * presented to a blind user to give an indication of the purpose
52 * of the icon.
53 *
54 * @return the description of the icon
55 */
56 public String getAccessibleIconDescription();
57
58 /**
59 * Sets the description of the icon. This is meant to be a brief
60 * textual description of the object. For example, it might be
61 * presented to a blind user to give an indication of the purpose
62 * of the icon.
63 *
64 * @param description the description of the icon
65 */
66 public void setAccessibleIconDescription(String description);
67
68 /**
69 * Gets the width of the icon
70 *
71 * @return the width of the icon.
72 */
73 public int getAccessibleIconWidth();
74
75 /**
76 * Gets the height of the icon
77 *
78 * @return the height of the icon.
79 */
80 public int getAccessibleIconHeight();
81
82 }
Save This Page