001    /* AccessibleSelection.java -- aids in accessibly selecting components
002       Copyright (C) 2000, 2002, 2005  Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    
039    package javax.accessibility;
040    
041    /**
042     * If an object implements this interface then it must be able to control
043     * the selection of its children. Accessibility software can use the
044     * implementations of this interface to change the selection set of children.
045     *
046     * <p>The <code>AccessibleContext.getAccessibleSelection()</code> method should
047     * return <code>null</code> if an object does not implement this interface.
048     *
049     * @author Eric Blake (ebb9@email.byu.edu)
050     * @see Accessible
051     * @see AccessibleContext
052     * @see AccessibleContext#getAccessibleSelection()
053     * @since 1.2
054     * @status updated to 1.4
055     */
056    public interface AccessibleSelection
057    {
058      /**
059       * Returns the number of currently selected Accessible children, which may
060       * be 0 if nothing is selected.
061       *
062       * @return the number of selected children
063       */
064      int getAccessibleSelectionCount();
065    
066      /**
067       * Returns the i-th selected child (not necessarily the overall i-th child)
068       * of this Accessible object. If i is out of bounds, null is returned.
069       *
070       * @param i zero-based index of selected child objects
071       * @return the Accessible child, or null
072       * @see #getAccessibleSelectionCount()
073       */
074      Accessible getAccessibleSelection(int i);
075    
076      /**
077       * Determine if i-th overall child of this accessible object is selected.
078       * If i is out of bounds, false is returned.
079       *
080       * @param i zero-based index of child objects
081       * @return true if specified child exists and is selected
082       */
083      boolean isAccessibleChildSelected(int i);
084    
085      /**
086       * Select the specified child if it is not already selected, placing it in
087       * the object's current selection. If the object does not support multiple
088       * selections then the new selection replaces the old. If the specified
089       * child is already selected, or is out of bounds, this method does nothing.
090       *
091       * @param i zero-based index of child objects
092       */
093      void addAccessibleSelection(int i);
094    
095      /**
096       * Unselect the specified child of this Accessible object. If the specified
097       * child is not selected, or is out of bounds, this method does nothing.
098       *
099       * @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