001/* ItemSelectable.java -- items that can be selected
002   Copyright (C) 1999, 2002, 2005  Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package java.awt;
040
041import java.awt.event.ItemListener;
042
043/**
044 * This interface is for objects that can have one or more items selected.
045 * For example, radio buttons.
046 *
047 * @author Aaron M. Renn (arenn@urbanophile.com)
048 * @since 1.0
049 * @status updated to 1.4
050 */
051public interface ItemSelectable
052{
053  /**
054   * Returns the list of objects that are selected in this component.
055   *
056   * @return the list of selected objects, or null
057   */
058  Object[] getSelectedObjects();
059
060  /**
061   * Adds an item listener to this object.  It will receive selection events
062   * for this object by the user (but not programatically). If listener is
063   * null, it is ignored.
064   *
065   * @param listener the item listener to add
066   */
067  void addItemListener(ItemListener listener);
068
069  /**
070   * Removes an item listener from this object.
071   *
072   * @param listener the item listener to remove
073   */
074  void removeItemListener(ItemListener listener);
075} // interface ItemSelectable