86 lines
2.9 KiB
Java
86 lines
2.9 KiB
Java
/* AccessibleIcon.java -- aids in accessibly rendering icons
|
|
Copyright (C) 2002, 2005 Free Software Foundation, Inc.
|
|
|
|
This file is part of GNU Classpath.
|
|
|
|
GNU Classpath is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 2, or (at your option)
|
|
any later version.
|
|
|
|
GNU Classpath is distributed in the hope that it will be useful, but
|
|
WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with GNU Classpath; see the file COPYING. If not, write to the
|
|
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
|
02110-1301 USA.
|
|
|
|
Linking this library statically or dynamically with other modules is
|
|
making a combined work based on this library. Thus, the terms and
|
|
conditions of the GNU General Public License cover the whole
|
|
combination.
|
|
|
|
As a special exception, the copyright holders of this library give you
|
|
permission to link this library with independent modules to produce an
|
|
executable, regardless of the license terms of these independent
|
|
modules, and to copy and distribute the resulting executable under
|
|
terms of your choice, provided that you also meet, for each linked
|
|
independent module, the terms and conditions of the license of that
|
|
module. An independent module is a module which is not derived from
|
|
or based on this library. If you modify this library, you may extend
|
|
this exception to your version of the library, but you are not
|
|
obligated to do so. If you do not wish to do so, delete this
|
|
exception statement from your version. */
|
|
|
|
|
|
package javax.accessibility;
|
|
|
|
/**
|
|
* Objects which have an associated icon, such as buttons, should implement
|
|
* this interface. Accessibility software can use the implementations of this
|
|
* interface to aid the user in navigating the links.
|
|
*
|
|
* <p>The <code>AccessibleContext.getAccessibleIcon()</code> method should
|
|
* return <code>null</code> if an object does not implement this interface.
|
|
*
|
|
* @author Eric Blake (ebb9@email.byu.edu)
|
|
* @see Accessible
|
|
* @see AccessibleContext
|
|
* @see AccessibleContext#getAccessibleIcon()
|
|
* @since 1.2
|
|
* @status updated to 1.4
|
|
*/
|
|
public interface AccessibleIcon
|
|
{
|
|
/**
|
|
* Returns a textual description of the icon and its purpose.
|
|
*
|
|
* @return the description, or null if there is none
|
|
*/
|
|
String getAccessibleIconDescription();
|
|
|
|
/**
|
|
* Modify the textual description of the icon and its purpose.
|
|
*
|
|
* @param s the new descrption string
|
|
*/
|
|
void setAccessibleIconDescription(String s);
|
|
|
|
/**
|
|
* Get the icon width.
|
|
*
|
|
* @return the width
|
|
*/
|
|
int getAccessibleIconWidth();
|
|
|
|
/**
|
|
* Get the icon height.
|
|
*
|
|
* @return the height
|
|
*/
|
|
int getAccessibleIconHeight();
|
|
} // interface AccessibleIcon
|