| 1 | /* AccessibleSelection.java -- aids in accessibly selecting components
|
|---|
| 2 | Copyright (C) 2000, 2002 Free Software Foundation, Inc.
|
|---|
| 3 |
|
|---|
| 4 | This file is part of GNU Classpath.
|
|---|
| 5 |
|
|---|
| 6 | GNU Classpath is free software; you can redistribute it and/or modify
|
|---|
| 7 | it under the terms of the GNU General Public License as published by
|
|---|
| 8 | the Free Software Foundation; either version 2, or (at your option)
|
|---|
| 9 | any later version.
|
|---|
| 10 |
|
|---|
| 11 | GNU Classpath is distributed in the hope that it will be useful, but
|
|---|
| 12 | WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|---|
| 14 | General Public License for more details.
|
|---|
| 15 |
|
|---|
| 16 | You should have received a copy of the GNU General Public License
|
|---|
| 17 | along with GNU Classpath; see the file COPYING. If not, write to the
|
|---|
| 18 | Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
|
|---|
| 19 | 02111-1307 USA.
|
|---|
| 20 |
|
|---|
| 21 | Linking this library statically or dynamically with other modules is
|
|---|
| 22 | making a combined work based on this library. Thus, the terms and
|
|---|
| 23 | conditions of the GNU General Public License cover the whole
|
|---|
| 24 | combination.
|
|---|
| 25 |
|
|---|
| 26 | As a special exception, the copyright holders of this library give you
|
|---|
| 27 | permission to link this library with independent modules to produce an
|
|---|
| 28 | executable, regardless of the license terms of these independent
|
|---|
| 29 | modules, and to copy and distribute the resulting executable under
|
|---|
| 30 | terms of your choice, provided that you also meet, for each linked
|
|---|
| 31 | independent module, the terms and conditions of the license of that
|
|---|
| 32 | module. An independent module is a module which is not derived from
|
|---|
| 33 | or based on this library. If you modify this library, you may extend
|
|---|
| 34 | this exception to your version of the library, but you are not
|
|---|
| 35 | obligated to do so. If you do not wish to do so, delete this
|
|---|
| 36 | exception statement from your version. */
|
|---|
| 37 |
|
|---|
| 38 |
|
|---|
| 39 | package javax.accessibility;
|
|---|
| 40 |
|
|---|
| 41 | /**
|
|---|
| 42 | * If an object implements this interface then it must be able to control
|
|---|
| 43 | * the selection of its children. Accessibility software can use the
|
|---|
| 44 | * implementations of this interface to change the selection set of children.
|
|---|
| 45 | *
|
|---|
| 46 | * <p>The <code>AccessibleContext.getAccessibleSelection()</code> method should
|
|---|
| 47 | * return <code>null</code> if an object does not implement this interface.
|
|---|
| 48 | *
|
|---|
| 49 | * @author Eric Blake <ebb9@email.byu.edu>
|
|---|
| 50 | * @see Accessible
|
|---|
| 51 | * @see AccessibleContext
|
|---|
| 52 | * @see AccessibleContext#getAccessibleSelection()
|
|---|
| 53 | * @since 1.2
|
|---|
| 54 | * @status updated to 1.4
|
|---|
| 55 | */
|
|---|
| 56 | public interface AccessibleSelection
|
|---|
| 57 | {
|
|---|
| 58 | /**
|
|---|
| 59 | * Returns the number of currently selected Accessible children, which may
|
|---|
| 60 | * be 0 if nothing is selected.
|
|---|
| 61 | *
|
|---|
| 62 | * @return the number of selected children
|
|---|
| 63 | */
|
|---|
| 64 | int getAccessibleSelectionCount();
|
|---|
| 65 |
|
|---|
| 66 | /**
|
|---|
| 67 | * Returns the i-th selected child (not necessarily the overall i-th child)
|
|---|
| 68 | * of this Accessible object. If i is out of bounds, null is returned.
|
|---|
| 69 | *
|
|---|
| 70 | * @param i zero-based index of selected child objects
|
|---|
| 71 | * @return the Accessible child, or null
|
|---|
| 72 | * @see #getAccessibleSelectionCount()
|
|---|
| 73 | */
|
|---|
| 74 | Accessible getAccessibleSelection(int i);
|
|---|
| 75 |
|
|---|
| 76 | /**
|
|---|
| 77 | * Determine if i-th overall child of this accessible object is selected.
|
|---|
| 78 | * If i is out of bounds, false is returned.
|
|---|
| 79 | *
|
|---|
| 80 | * @param i zero-based index of child objects
|
|---|
| 81 | * @return true if specified child exists and is selected
|
|---|
| 82 | */
|
|---|
| 83 | boolean isAccessibleChildSelected(int i);
|
|---|
| 84 |
|
|---|
| 85 | /**
|
|---|
| 86 | * Select the specified child if it is not already selected, placing it in
|
|---|
| 87 | * the object's current selection. If the object does not support multiple
|
|---|
| 88 | * selections then the new selection replaces the old. If the specified
|
|---|
| 89 | * child is already selected, or is out of bounds, this method does nothing.
|
|---|
| 90 | *
|
|---|
| 91 | * @param i zero-based index of child objects
|
|---|
| 92 | */
|
|---|
| 93 | void addAccessibleSelection(int i);
|
|---|
| 94 |
|
|---|
| 95 | /**
|
|---|
| 96 | * Unselect the specified child of this Accessible object. If the specified
|
|---|
| 97 | * child is not selected, or is out of bounds, this method does nothing.
|
|---|
| 98 | *
|
|---|
| 99 | * @param i the zero-based index of the child objects
|
|---|
| 100 | */
|
|---|
| 101 | void removeAccessibleSelection(int i);
|
|---|
| 102 |
|
|---|
| 103 | /**
|
|---|
| 104 | * Unselect all children of this Accessible object.
|
|---|
| 105 | */
|
|---|
| 106 | void clearAccessibleSelection();
|
|---|
| 107 |
|
|---|
| 108 | /**
|
|---|
| 109 | * Select all children of this Accessible object if the object supports
|
|---|
| 110 | * multiple selections or has a single child. Otherwise this does nothing.
|
|---|
| 111 | */
|
|---|
| 112 | void selectAllAccessibleSelection();
|
|---|
| 113 | } // interface AccessibleSelection
|
|---|
