src/share/classes/java/awt/ItemSelectable.java

Print this page


   1 /*
   2  * Copyright (c) 1996, 2000, Oracle and/or its affiliates. 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.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package java.awt;
  27 
  28 import java.awt.event.*;
  29 
  30 /**
  31  * The interface for objects which contain a set of items for
  32  * which zero or more can be selected.
  33  *
  34  * @author Amy Fowler
  35  */
  36 
  37 public interface ItemSelectable {
  38 
  39     /**
  40      * Returns the selected items or <code>null</code> if no
  41      * items are selected.


  42      */
  43     public Object[] getSelectedObjects();
  44 
  45     /**
  46      * Adds a listener to receive item events when the state of an item is
  47      * changed by the user. Item events are not sent when an item's
  48      * state is set programmatically.  If <code>l</code> is
  49      * <code>null</code>, no exception is thrown and no action is performed.
  50      *
  51      * @param    l the listener to receive events
  52      * @see ItemEvent
  53      */
  54     public void addItemListener(ItemListener l);
  55 
  56     /**
  57      * Removes an item listener.
  58      * If <code>l</code> is <code>null</code>,
  59      * no exception is thrown and no action is performed.
  60      *
  61      * @param   l the listener being removed
   1 /*
   2  * Copyright (c) 1996, 2014, Oracle and/or its affiliates. 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.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package java.awt;
  27 
  28 import java.awt.event.*;
  29 
  30 /**
  31  * The interface for objects which contain a set of items for
  32  * which zero or more can be selected.
  33  *
  34  * @author Amy Fowler
  35  */
  36 
  37 public interface ItemSelectable {
  38 
  39     /**
  40      * Returns the selected items or <code>null</code> if no
  41      * items are selected.
  42      *
  43      * @return the list of selected objects, or {@code null}
  44      */
  45     public Object[] getSelectedObjects();
  46 
  47     /**
  48      * Adds a listener to receive item events when the state of an item is
  49      * changed by the user. Item events are not sent when an item's
  50      * state is set programmatically.  If <code>l</code> is
  51      * <code>null</code>, no exception is thrown and no action is performed.
  52      *
  53      * @param    l the listener to receive events
  54      * @see ItemEvent
  55      */
  56     public void addItemListener(ItemListener l);
  57 
  58     /**
  59      * Removes an item listener.
  60      * If <code>l</code> is <code>null</code>,
  61      * no exception is thrown and no action is performed.
  62      *
  63      * @param   l the listener being removed