List.java 30.3 KB
Newer Older
Tom Tromey committed
1
/* List.java -- A listbox widget
2
   Copyright (C) 1999, 2002, 2004, 2006,  Free Software Foundation, Inc.
Tom Tromey committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56

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 java.awt;

import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.ItemEvent;
import java.awt.event.ItemListener;
import java.awt.peer.ListPeer;
import java.util.EventListener;
import java.util.Vector;

import javax.accessibility.Accessible;
import javax.accessibility.AccessibleContext;
import javax.accessibility.AccessibleRole;
import javax.accessibility.AccessibleSelection;
import javax.accessibility.AccessibleState;
import javax.accessibility.AccessibleStateSet;

/**
57 58 59 60
 * Class that implements a listbox widget
 *
 * @author Aaron M. Renn (arenn@urbanophile.com)
 */
Tom Tromey committed
61 62 63 64
public class List extends Component
  implements ItemSelectable, Accessible
{

65 66 67
  /**
   * The number used to generate the name returned by getName.
   */
68
  private static transient long next_list_number;
Tom Tromey committed
69

70 71
  // Serialization constant
  private static final long serialVersionUID = -3304312411574666869L;
Tom Tromey committed
72

73
  // FIXME: Need read/writeObject
Tom Tromey committed
74

75 76 77 78
  /**
    * @serial The items in the list.
    */
  private Vector items = new Vector();
Tom Tromey committed
79

80 81 82 83 84
  /**
   * @serial Indicates whether or not multiple items can be selected
   * simultaneously.
   */
  private boolean multipleMode;
Tom Tromey committed
85

86 87 88 89 90
  /**
   * @serial The number of rows in the list.  This is set on creation
   * only and cannot be modified.
   */
  private int rows;
Tom Tromey committed
91

92 93 94 95
  /**
   * @serial An array of the item indices that are selected.
   */
  private int[] selected;
Tom Tromey committed
96

97 98 99 100 101
  /**
   * @serial An index value used by <code>makeVisible()</code> and
   * <code>getVisibleIndex</code>.
   */
  private int visibleIndex = -1;
Tom Tromey committed
102

103 104
  // The list of ItemListeners for this object.
  private ItemListener item_listeners;
Tom Tromey committed
105

106 107
  // The list of ActionListeners for this object.
  private ActionListener action_listeners;
Tom Tromey committed
108

109 110 111 112 113 114 115 116 117 118 119
  /**
   * Initializes a new instance of <code>List</code> with no visible lines
   * and multi-select disabled.
   *
   * @exception HeadlessException If GraphicsEnvironment.isHeadless() is true.
   * @since 1.1
   */
  public List()
  {
    this(4, false);
  }
Tom Tromey committed
120

121 122 123 124 125 126 127 128 129 130 131 132
  /**
   * Initializes a new instance of <code>List</code> with the specified
   * number of visible lines and multi-select disabled.
   *
   * @param rows The number of visible rows in the list.
   *
   * @exception HeadlessException If GraphicsEnvironment.isHeadless() is true.
   */
  public List(int rows)
  {
    this(rows, false);
  }
Tom Tromey committed
133

134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
  /**
   * Initializes a new instance of <code>List</code> with the specified
   * number of lines and the specified multi-select setting.
   *
   * @param rows The number of visible rows in the list.
   * @param multipleMode <code>true</code> if multiple lines can be selected
   * simultaneously, <code>false</code> otherwise.
   *
   * @exception HeadlessException If GraphicsEnvironment.isHeadless() is true.
   */
  public List(int rows, boolean multipleMode)
  {
    if (rows == 0)
      this.rows = 4;
    else
      this.rows = rows;
150

151 152
    this.multipleMode = multipleMode;
    selected = new int[0];
Tom Tromey committed
153

154 155
    if (GraphicsEnvironment.isHeadless())
      throw new HeadlessException();
156

157
  }
Tom Tromey committed
158

159 160 161 162
  /**
   * Returns the number of items in this list.
   *
   * @return The number of items in this list.
163
   *
164 165 166 167 168 169
   * @since 1.1
   */
  public int getItemCount()
  {
    return countItems();
  }
Tom Tromey committed
170

171 172 173 174 175 176 177 178 179 180 181 182
  /**
   * Returns the number of items in this list.
   *
   * @return The number of items in this list.
   *
   * @deprecated This method is deprecated in favor of
   * <code>getItemCount()</code>
   */
  public int countItems()
  {
    return items.size();
  }
Tom Tromey committed
183

184 185 186 187
  /**
   * Returns the complete list of items.
   *
   * @return The complete list of items in the list.
188
   *
189 190 191 192 193
   * @since 1.1
   */
  public synchronized String[] getItems()
  {
    String[] l_items = new String[getItemCount()];
194

195 196 197
    items.copyInto(l_items);
    return(l_items);
  }
Tom Tromey committed
198

199 200 201 202 203 204 205 206 207 208 209
  /**
   * Returns the item at the specified index.
   *
   * @param index The index of the item to retrieve.
   *
   * @exception IndexOutOfBoundsException If the index value is not valid.
   */
  public String getItem(int index)
  {
    return((String) items.elementAt(index));
  }
Tom Tromey committed
210

211 212 213 214 215 216 217 218 219
  /**
   * Returns the number of visible rows in the list.
   *
   * @return The number of visible rows in the list.
   */
  public int getRows()
  {
    return(rows);
  }
Tom Tromey committed
220

221 222 223 224 225
  /**
   * Tests whether or not multi-select mode is enabled.
   *
   * @return <code>true</code> if multi-select mode is enabled,
   * <code>false</code> otherwise.
226
   *
227 228 229 230 231 232
   * @since 1.1
   */
  public boolean isMultipleMode()
  {
    return allowsMultipleSelections ();
  }
Tom Tromey committed
233

234 235 236 237 238 239
  /**
   * Tests whether or not multi-select mode is enabled.
   *
   * @return <code>true</code> if multi-select mode is enabled,
   * <code>false</code> otherwise.
   *
240
   * @deprecated This method is deprecated in favor of
241 242 243 244 245 246
   * <code>isMultipleMode()</code>.
   */
  public boolean allowsMultipleSelections()
  {
    return multipleMode;
  }
Tom Tromey committed
247

248 249 250 251 252 253
  /**
   * This method enables or disables multiple selection mode for this
   * list.
   *
   * @param multipleMode <code>true</code> to enable multiple mode,
   * <code>false</code> otherwise.
254
   *
255 256 257 258 259 260
   * @since 1.1
   */
  public void setMultipleMode(boolean multipleMode)
  {
    setMultipleSelections (multipleMode);
  }
Tom Tromey committed
261

262 263 264 265 266 267 268 269 270 271
  /**
   * This method enables or disables multiple selection mode for this
   * list.
   *
   * @param multipleMode <code>true</code> to enable multiple mode,
   * <code>false</code> otherwise.
   *
   * @deprecated
   */
  public void setMultipleSelections(boolean multipleMode)
272
  {
273 274 275 276 277
    this.multipleMode = multipleMode;

    ListPeer peer = (ListPeer) getPeer();
    if (peer != null)
      peer.setMultipleMode(multipleMode);
278

279
  }
Tom Tromey committed
280

281 282 283 284
  /**
   * Returns the minimum size of this component.
   *
   * @return The minimum size of this component.
285
   *
286 287 288 289 290 291
   * @since 1.1
   */
  public Dimension getMinimumSize()
  {
    return getMinimumSize(getRows());
  }
Tom Tromey committed
292

293 294 295 296 297 298 299 300 301 302 303 304
  /**
   * Returns the minimum size of this component.
   *
   * @return The minimum size of this component.
   *
   * @deprecated This method is deprecated in favor of
   * <code>getMinimumSize</code>.
   */
  public Dimension minimumSize()
  {
    return minimumSize(getRows());
  }
Tom Tromey committed
305

306 307 308 309 310 311 312
  /**
   * Returns the minimum size of this component assuming it had the specified
   * number of rows.
   *
   * @param rows The number of rows to size for.
   *
   * @return The minimum size of this component.
313
   *
314 315 316 317 318 319
   * @since 1.1
   */
  public Dimension getMinimumSize(int rows)
  {
    return minimumSize(rows);
  }
Tom Tromey committed
320

321 322 323 324 325 326 327 328
  /**
   * Returns the minimum size of this component assuming it had the specified
   * number of rows.
   *
   * @param rows The number of rows to size for.
   *
   * @return The minimum size of this component.
   *
329
   * @deprecated This method is deprecated in favor of
330 331 332 333 334 335 336 337 338 339
   * <code>getMinimumSize(int)</code>>
   */
  public Dimension minimumSize(int rows)
  {
    ListPeer peer = (ListPeer) getPeer();
    if (peer != null)
      return peer.minimumSize(rows);
    else
      return new Dimension(0, 0);
  }
Tom Tromey committed
340

341 342 343 344
  /**
   * Returns the preferred size of this component.
   *
   * @return The preferred size of this component.
345
   *
346 347 348 349 350 351
   * @since 1.1
   */
  public Dimension getPreferredSize()
  {
    return getPreferredSize(getRows());
  }
Tom Tromey committed
352

353 354 355 356 357 358 359 360
  /**
   * Returns the preferred size of this component.
   *
   * @return The preferred size of this component.
   *
   * @deprecated This method is deprecated in favor of
   * <code>getPreferredSize</code>.
   */
361
  public Dimension preferredSize()
362 363 364
  {
    return preferredSize(getRows());
  }
Tom Tromey committed
365

366 367 368 369 370 371 372
  /**
   * Returns the preferred size of this component assuming it had the specified
   * number of rows.
   *
   * @param rows The number of rows to size for.
   *
   * @return The preferred size of this component.
373
   *
374 375 376 377 378 379
   * @since 1.1
   */
  public Dimension getPreferredSize(int rows)
  {
    return preferredSize(rows);
  }
Tom Tromey committed
380

381 382 383 384 385 386 387 388
  /**
   * Returns the preferred size of this component assuming it had the specified
   * number of rows.
   *
   * @param rows The number of rows to size for.
   *
   * @return The preferred size of this component.
   *
389
   * @deprecated This method is deprecated in favor of
390 391 392 393 394 395 396 397 398 399
   * <code>getPreferredSize(int)</code>>
   */
  public Dimension preferredSize(int rows)
  {
    ListPeer peer = (ListPeer)getPeer();
    if (peer != null)
      return peer.preferredSize(rows);
    else
      return getSize();
  }
Tom Tromey committed
400

401 402 403 404
  /**
   * This method adds the specified item to the end of the list.
   *
   * @param item The item to add to the list.
405
   *
406 407 408 409 410 411
   * @since 1.1
   */
  public void add(String item)
  {
    add (item, -1);
  }
Tom Tromey committed
412

413 414 415 416 417 418 419 420 421 422 423
  /**
   * This method adds the specified item to the end of the list.
   *
   * @param item The item to add to the list.
   *
   * @deprecated Use add() instead.
   */
  public void addItem(String item)
  {
    addItem(item, -1);
  }
Tom Tromey committed
424

425 426 427 428 429 430 431 432
  /**
   * Adds the specified item to the specified location in the list.
   * If the desired index is -1 or greater than the number of rows
   * in the list, then the item is added to the end.
   *
   * @param item The item to add to the list.
   * @param index The location in the list to add the item, or -1 to add
   * to the end.
433
   *
434 435 436 437 438 439
   * @since 1.1
   */
  public void add(String item, int index)
  {
    addItem(item, index);
  }
Tom Tromey committed
440

441 442 443 444 445 446 447 448 449 450 451 452 453 454
  /**
   * Adds the specified item to the specified location in the list.
   * If the desired index is -1 or greater than the number of rows
   * in the list, then the item is added to the end.
   *
   * @param item The item to add to the list.
   * @param index The location in the list to add the item, or -1 to add
   * to the end.
   *
   * @deprecated Use add() instead.
   */
  public void addItem(String item, int index)
  {
    if (item == null)
455 456
      item = "";

457 458
    if (index < -1)
      index = -1;
459

460 461 462 463 464 465 466 467 468
    if ((index == -1) || (index >= items.size ()))
      items.addElement (item);
    else
      items.insertElementAt(item, index);

    ListPeer peer = (ListPeer) getPeer();
    if (peer != null)
      peer.add (item, index);
  }
Tom Tromey committed
469

470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
  /**
   * Deletes the item at the specified index.
   *
   * @param index The index of the item to delete.
   *
   * @exception IllegalArgumentException If the index is not valid
   *
   * @deprecated
   */
  public void delItem(int index) throws IllegalArgumentException
  {
    boolean selected = false;
    if (isSelected(index))
      {
        selected = true;
485
        deselect(index);
486
      }
487

488
    items.removeElementAt (index);
489

490 491
    if (selected)
      select(index);
Tom Tromey committed
492

493 494 495 496
    ListPeer peer = (ListPeer) getPeer();
    if (peer != null)
      peer.delItems (index, index);
  }
Tom Tromey committed
497

498 499 500 501 502 503
  /**
   * Deletes the item at the specified index.
   *
   * @param index The index of the item to delete.
   *
   * @exception IllegalArgumentException If the index is not valid
504
   *
505 506 507 508 509 510
   * @since 1.1
   */
  public void remove(int index) throws IllegalArgumentException
  {
    delItem(index);
  }
Tom Tromey committed
511

512 513 514 515 516 517 518 519 520 521
  /**
   * Deletes all items in the specified index range.
   *
   * @param start The beginning index of the range to delete.
   * @param end The ending index of the range to delete.
   *
   * @exception IllegalArgumentException If the indexes are not valid
   *
   * @deprecated This method is deprecated for some unknown reason.
   */
522
  public synchronized void delItems(int start, int end)
523 524 525 526 527 528 529 530 531 532 533
    throws IllegalArgumentException
  {
    // We must run the loop in reverse direction.
    for (int i = end; i >= start; --i)
      items.removeElementAt (i);
    if (peer != null)
      {
        ListPeer l = (ListPeer) peer;
        l.delItems (start, end);
      }
  }
Tom Tromey committed
534

535 536 537 538 539 540
  /**
   * Deletes the first occurrence of the specified item from the list.
   *
   * @param item The item to delete.
   *
   * @exception IllegalArgumentException If the specified item does not exist.
541
   *
542 543 544 545 546 547 548
   * @since 1.1
   */
  public synchronized void remove(String item) throws IllegalArgumentException
  {
    int index = items.indexOf(item);
    if (index == -1)
      throw new IllegalArgumentException("List element to delete not found");
Tom Tromey committed
549

550 551
    remove(index);
  }
Tom Tromey committed
552

553 554
  /**
   * Deletes all of the items from the list.
555
   *
556 557 558 559 560 561
   * @since 1.1
   */
  public synchronized void removeAll()
  {
    clear();
  }
Tom Tromey committed
562

563 564
  /**
   * Deletes all of the items from the list.
565
   *
566 567 568 569 570
   * @deprecated This method is deprecated in favor of <code>removeAll()</code>.
   */
  public void clear()
  {
    items.clear();
Tom Tromey committed
571

572 573 574
    ListPeer peer = (ListPeer) getPeer();
    if (peer != null)
      peer.removeAll();
575

576 577
    selected = new int[0];
  }
Tom Tromey committed
578

579 580 581 582 583 584 585 586
  /**
   * Replaces the item at the specified index with the specified item.
   *
   * @param item The new item value.
   * @param index The index of the item to replace.
   *
   * @exception ArrayIndexOutOfBoundsException If the index is not valid.
   */
587
  public synchronized void replaceItem(String item, int index)
588 589 590 591
    throws ArrayIndexOutOfBoundsException
  {
    if ((index < 0) || (index >= items.size()))
      throw new ArrayIndexOutOfBoundsException("Bad list index: " + index);
Tom Tromey committed
592

593 594
    items.insertElementAt(item, index + 1);
    items.removeElementAt (index);
Tom Tromey committed
595

596 597 598
    if (peer != null)
      {
        ListPeer l = (ListPeer) peer;
Tom Tromey committed
599

600
        /* We add first and then remove so that the selected
601
           item remains the same */
602 603 604 605
        l.add (item, index + 1);
        l.delItems (index, index);
      }
  }
Tom Tromey committed
606

607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622
  /**
   * Returns the index of the currently selected item.  -1 will be returned
   * if there are no selected rows or if there are multiple selected rows.
   *
   * @return The index of the selected row.
   */
  public synchronized int getSelectedIndex()
  {
    if (peer != null)
      {
        ListPeer l = (ListPeer) peer;
        selected = l.getSelectedIndexes ();
      }

    if (selected == null || selected.length != 1)
      return -1;
623

624 625
    return selected[0];
  }
Tom Tromey committed
626

627
  /**
628
   * Returns an array containing the indexes of the rows that are
629 630 631 632 633 634 635 636 637 638
   * currently selected.
   *
   * @return A list of indexes of selected rows.
   */
  public synchronized int[] getSelectedIndexes()
  {
    if (peer != null)
      {
        ListPeer l = (ListPeer) peer;
        selected = l.getSelectedIndexes();
639 640
      }

641 642
    return selected;
  }
Tom Tromey committed
643

644
  /**
645
   * Returns the item that is currently selected, or <code>null</code> if there
646 647 648 649 650 651 652 653 654 655
   * is no item selected.  FIXME: What happens if multiple items selected?
   *
   * @return The selected item, or <code>null</code> if there is no
   * selected item.
   */
  public synchronized String getSelectedItem()
  {
    int index = getSelectedIndex();
    if (index == -1)
      return(null);
Tom Tromey committed
656

657 658
    return((String) items.elementAt(index));
  }
Tom Tromey committed
659

660 661 662 663 664 665 666 667 668 669
  /**
   * Returns the list of items that are currently selected in this list.
   *
   * @return The list of currently selected items.
   */
  public synchronized String[] getSelectedItems()
  {
    int[] indexes = getSelectedIndexes();
    if (indexes == null)
      return(new String[0]);
Tom Tromey committed
670

671 672 673 674
    String[] retvals = new String[indexes.length];
    if (retvals.length > 0)
      for (int i = 0 ; i < retvals.length; i++)
         retvals[i] = (String)items.elementAt(indexes[i]);
Tom Tromey committed
675

676 677
    return(retvals);
  }
Tom Tromey committed
678

679 680 681 682 683 684 685 686 687 688 689
  /**
   * Returns the list of items that are currently selected in this list as
   * an array of type <code>Object[]</code> instead of <code>String[]</code>.
   *
   * @return The list of currently selected items.
   */
  public synchronized Object[] getSelectedObjects()
  {
    int[] indexes = getSelectedIndexes();
    if (indexes == null)
      return(new Object[0]);
Tom Tromey committed
690

691 692 693 694
    Object[] retvals = new Object[indexes.length];
    if (retvals.length > 0)
      for (int i = 0 ; i < retvals.length; i++)
         retvals[i] = items.elementAt(indexes[i]);
Tom Tromey committed
695

696 697
    return(retvals);
  }
Tom Tromey committed
698

699 700 701 702 703 704 705
  /**
   * Tests whether or not the specified index is selected.
   *
   * @param index The index to test.
   *
   * @return <code>true</code> if the index is selected, <code>false</code>
   * otherwise.
706
   *
707 708 709 710 711 712
   * @since 1.1
   */
  public boolean isIndexSelected(int index)
  {
    return isSelected(index);
  }
Tom Tromey committed
713

714 715 716 717 718 719 720 721 722 723 724 725 726 727
  /**
   * Tests whether or not the specified index is selected.
   *
   * @param index The index to test.
   *
   * @return <code>true</code> if the index is selected, <code>false</code>
   * otherwise.
   *
   * @deprecated This method is deprecated in favor of
   * <code>isIndexSelected(int)</code>.
   */
  public boolean isSelected(int index)
  {
    int[] indexes = getSelectedIndexes();
Tom Tromey committed
728

729 730 731
    for (int i = 0; i < indexes.length; i++)
      if (indexes[i] == index)
        return true;
Tom Tromey committed
732

733 734
    return false;
  }
Tom Tromey committed
735

736 737 738 739 740
  /**
   * This method ensures that the item at the specified index is visible.
   *
   * @param index The index of the item to be made visible.
   */
741
  public synchronized void makeVisible(int index)
742 743 744 745 746 747 748 749 750
    throws IllegalArgumentException
  {
    visibleIndex = index;
    if (peer != null)
      {
        ListPeer l = (ListPeer) peer;
        l.makeVisible (index);
      }
  }
Tom Tromey committed
751

752 753 754 755
  /**
   * Returns the index of the last item that was made visible via the
   * <code>makeVisible()</code> method.
   *
756
   * @return The index of the last item made visible via the
757 758 759 760 761 762
   * <code>makeVisible()</code> method.
   */
  public int getVisibleIndex()
  {
    return visibleIndex;
  }
Tom Tromey committed
763

764 765 766 767 768 769 770 771 772 773
  /**
   * Makes the item at the specified index selected.
   *
   * @param index The index of the item to select.
   */
  public synchronized void select(int index)
  {
    ListPeer lp = (ListPeer) getPeer();
    if (lp != null)
      lp.select(index);
774

775 776 777 778 779 780 781 782 783 784 785 786 787 788
   if (selected != null)
     {
       boolean found = false;
       for (int i = 0; i < selected.length; i++)
         {
           if (selected[i] == index)
           found = true;
         }
       if (! found)
         {
           if (! isMultipleMode())
             {
               selected = new int[] { index };
               return;
789
             }
790 791 792 793 794
           int[] temp = new int[selected.length + 1];
           System.arraycopy(selected, 0, temp, 0, selected.length);
           temp[selected.length] = index;
           selected = temp;
         }
795 796
     }
   else
797 798 799 800 801
     {
       selected = new int[1];
       selected[0] = index;
     }
  }
Tom Tromey committed
802

803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822
  /**
   * Makes the item at the specified index not selected.
   *
   * @param index The index of the item to unselect.
   */
  public synchronized void deselect(int index)
  {
    if (isSelected(index))
      {
        ListPeer lp = (ListPeer)getPeer();
        if (lp != null)
          lp.deselect(index);

        int[] temp = new int[selected.length - 1];
        for (int i = 0; i < temp.length; i++)
          {
            if (selected[i] != index)
              temp[i] = selected[i];
            else
              {
823
                System.arraycopy(selected, i + 1, temp, i,
824 825 826 827 828 829 830
                                 selected.length - i - 1);
                break;
              }
          }
        selected = temp;
      }
  }
Tom Tromey committed
831

832 833 834 835 836 837 838 839 840
  /**
   * Notifies this object to create its native peer.
   */
  public void addNotify()
  {
    if (peer == null)
      peer = getToolkit ().createList(this);
    super.addNotify ();
  }
Tom Tromey committed
841

842 843 844 845 846 847 848
  /**
   * Notifies this object to destroy its native peer.
   */
  public void removeNotify()
  {
    super.removeNotify();
  }
Tom Tromey committed
849

850 851 852 853 854
  /**
   * Adds the specified <code>ActionListener</code> to the list of
   * registered listeners for this object.
   *
   * @param listener The listener to add.
855
   *
856 857 858 859 860 861
   * @since 1.1
   */
  public synchronized void addActionListener(ActionListener listener)
  {
    action_listeners = AWTEventMulticaster.add(action_listeners, listener);
  }
Tom Tromey committed
862

863 864 865 866 867
  /**
   * Removes the specified <code>ActionListener</code> from the list of
   * registers listeners for this object.
   *
   * @param listener The listener to remove.
868
   *
869 870 871 872 873 874
   * @since 1.1
   */
  public synchronized void removeActionListener(ActionListener listener)
  {
    action_listeners = AWTEventMulticaster.remove(action_listeners, listener);
  }
Tom Tromey committed
875

876 877 878 879 880
  /**
   * Adds the specified <code>ItemListener</code> to the list of
   * registered listeners for this object.
   *
   * @param listener The listener to add.
881
   *
882 883 884 885 886 887
   * @since 1.1
   */
  public synchronized void addItemListener(ItemListener listener)
  {
    item_listeners = AWTEventMulticaster.add(item_listeners, listener);
  }
Tom Tromey committed
888

889 890 891 892 893
  /**
   * Removes the specified <code>ItemListener</code> from the list of
   * registers listeners for this object.
   *
   * @param listener The listener to remove.
894
   *
895 896 897 898 899 900
   * @since 1.1
   */
  public synchronized void removeItemListener(ItemListener listener)
  {
    item_listeners = AWTEventMulticaster.remove(item_listeners, listener);
  }
Tom Tromey committed
901

902 903 904 905 906 907 908 909 910
  /**
   * Processes the specified event for this object.  If the event is an
   * instance of <code>ActionEvent</code> then the
   * <code>processActionEvent()</code> method is called.  Similarly, if the
   * even is an instance of <code>ItemEvent</code> then the
   * <code>processItemEvent()</code> method is called.  Otherwise the
   * superclass method is called to process this event.
   *
   * @param event The event to process.
911
   *
912 913 914 915 916 917 918 919 920 921 922
   * @since 1.1
   */
  protected void processEvent(AWTEvent event)
  {
    if (event instanceof ActionEvent)
      processActionEvent((ActionEvent)event);
    else if (event instanceof ItemEvent)
      processItemEvent((ItemEvent)event);
    else
      super.processEvent(event);
  }
Tom Tromey committed
923

924 925 926 927 928 929 930 931
  /**
   * This method processes the specified event by dispatching it to any
   * registered listeners.  Note that this method will only get called if
   * action events are enabled.  This will happen automatically if any
   * listeners are added, or it can be done "manually" by calling
   * the <code>enableEvents()</code> method.
   *
   * @param event The event to process.
932
   *
933 934 935 936 937 938 939
   * @since 1.1
   */
  protected void processActionEvent(ActionEvent event)
  {
    if (action_listeners != null)
      action_listeners.actionPerformed(event);
  }
Tom Tromey committed
940

941 942 943 944 945 946 947 948
  /**
   * This method processes the specified event by dispatching it to any
   * registered listeners.  Note that this method will only get called if
   * item events are enabled.  This will happen automatically if any
   * listeners are added, or it can be done "manually" by calling
   * the <code>enableEvents()</code> method.
   *
   * @param event The event to process.
949
   *
950 951 952 953 954 955 956
   * @since 1.1
   */
  protected void processItemEvent(ItemEvent event)
  {
    if (item_listeners != null)
      item_listeners.itemStateChanged(event);
  }
Tom Tromey committed
957

958 959 960 961
  void dispatchEventImpl(AWTEvent e)
  {
    if (e.id <= ItemEvent.ITEM_LAST
        && e.id >= ItemEvent.ITEM_FIRST
962
        && (item_listeners != null
963 964
        || (eventMask & AWTEvent.ITEM_EVENT_MASK) != 0))
      processEvent(e);
965 966 967
    else if (e.id <= ActionEvent.ACTION_LAST
           && e.id >= ActionEvent.ACTION_FIRST
           && (action_listeners != null
968 969 970 971 972
           || (eventMask & AWTEvent.ACTION_EVENT_MASK) != 0))
      processEvent(e);
    else
      super.dispatchEventImpl(e);
  }
Tom Tromey committed
973

974 975 976 977 978 979 980 981 982
  /**
   * Returns a debugging string for this object.
   *
   * @return A debugging string for this object.
   */
  protected String paramString()
  {
    return "multiple=" + multipleMode + ",rows=" + rows + super.paramString();
  }
Tom Tromey committed
983 984 985

  /**
   * Returns an array of all the objects currently registered as FooListeners
986
   * upon this <code>List</code>. FooListeners are registered using the
Tom Tromey committed
987 988 989 990
   * addFooListener method.
   *
   * @exception ClassCastException If listenerType doesn't specify a class or
   * interface that implements java.util.EventListener.
991
   *
992
   * @since 1.3
Tom Tromey committed
993
   */
994
  public <T extends EventListener> T[] getListeners (Class<T> listenerType)
Tom Tromey committed
995 996 997
  {
    if (listenerType == ActionListener.class)
      return AWTEventMulticaster.getListeners (action_listeners, listenerType);
998

Tom Tromey committed
999 1000 1001 1002 1003 1004 1005 1006
    if (listenerType == ItemListener.class)
      return AWTEventMulticaster.getListeners (item_listeners, listenerType);

    return super.getListeners (listenerType);
  }

  /**
   * Returns all action listeners registered to this object.
1007
   *
1008
   * @since 1.4
Tom Tromey committed
1009 1010 1011 1012 1013
   */
  public ActionListener[] getActionListeners ()
  {
    return (ActionListener[]) getListeners (ActionListener.class);
  }
1014

Tom Tromey committed
1015 1016
  /**
   * Returns all action listeners registered to this object.
1017
   *
1018
   * @since 1.4
Tom Tromey committed
1019 1020 1021 1022 1023
   */
  public ItemListener[] getItemListeners ()
  {
    return (ItemListener[]) getListeners (ItemListener.class);
  }
1024 1025

  // Accessibility internal class
Tom Tromey committed
1026 1027 1028
  protected class AccessibleAWTList extends AccessibleAWTComponent
    implements AccessibleSelection, ItemListener, ActionListener
  {
1029 1030
    private static final long serialVersionUID = 7924617370136012829L;

Tom Tromey committed
1031 1032 1033
    protected class AccessibleAWTListChild extends AccessibleAWTComponent
      implements Accessible
    {
1034
      private static final long serialVersionUID = 4412022926028300317L;
1035

1036
      // Field names are fixed by serialization spec.
Tom Tromey committed
1037
      private List parent;
1038
      private int indexInParent;
1039

Tom Tromey committed
1040 1041 1042
      public AccessibleAWTListChild(List parent, int indexInParent)
      {
        this.parent = parent;
1043
        this.indexInParent = indexInParent;
Tom Tromey committed
1044
        if (parent == null)
1045
          this.indexInParent = -1;
Tom Tromey committed
1046
      }
1047

Tom Tromey committed
1048 1049 1050 1051 1052 1053 1054
      /* (non-Javadoc)
       * @see javax.accessibility.Accessible#getAccessibleContext()
       */
      public AccessibleContext getAccessibleContext()
      {
        return this;
      }
1055

Tom Tromey committed
1056 1057 1058 1059
      public AccessibleRole getAccessibleRole()
      {
        return AccessibleRole.LIST_ITEM;
      }
1060

Tom Tromey committed
1061 1062 1063
      public AccessibleStateSet getAccessibleStateSet()
      {
        AccessibleStateSet states = super.getAccessibleStateSet();
1064
        if (parent.isIndexSelected(indexInParent))
Tom Tromey committed
1065 1066 1067
          states.add(AccessibleState.SELECTED);
        return states;
      }
1068

Tom Tromey committed
1069 1070
      public int getAccessibleIndexInParent()
      {
1071
        return indexInParent;
Tom Tromey committed
1072 1073 1074
      }

    }
1075

Tom Tromey committed
1076 1077 1078 1079 1080
    public AccessibleAWTList()
    {
      addItemListener(this);
      addActionListener(this);
    }
1081

Tom Tromey committed
1082 1083 1084 1085
    public AccessibleRole getAccessibleRole()
    {
      return AccessibleRole.LIST;
    }
1086

Tom Tromey committed
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
    public AccessibleStateSet getAccessibleStateSet()
    {
      AccessibleStateSet states = super.getAccessibleStateSet();
      states.add(AccessibleState.SELECTABLE);
      if (isMultipleMode())
        states.add(AccessibleState.MULTISELECTABLE);
      return states;
    }

    public int getAccessibleChildrenCount()
    {
      return getItemCount();
    }

    public Accessible getAccessibleChild(int i)
    {
      if (i >= getItemCount())
        return null;
      return new AccessibleAWTListChild(List.this, i);
    }
1107

Tom Tromey committed
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190
    /* (non-Javadoc)
     * @see javax.accessibility.AccessibleSelection#getAccessibleSelectionCount()
     */
    public int getAccessibleSelectionCount()
    {
      return getSelectedIndexes().length;
    }

    /* (non-Javadoc)
     * @see javax.accessibility.AccessibleSelection#getAccessibleSelection()
     */
    public AccessibleSelection getAccessibleSelection()
    {
      return this;
    }

    /* (non-Javadoc)
     * @see javax.accessibility.AccessibleSelection#getAccessibleSelection(int)
     */
    public Accessible getAccessibleSelection(int i)
    {
      int[] items = getSelectedIndexes();
      if (i >= items.length)
        return null;
      return new AccessibleAWTListChild(List.this, items[i]);
    }

    /* (non-Javadoc)
     * @see javax.accessibility.AccessibleSelection#isAccessibleChildSelected(int)
     */
    public boolean isAccessibleChildSelected(int i)
    {
      return isIndexSelected(i);
    }

    /* (non-Javadoc)
     * @see javax.accessibility.AccessibleSelection#addAccessibleSelection(int)
     */
    public void addAccessibleSelection(int i)
    {
      select(i);
    }

    /* (non-Javadoc)
     * @see javax.accessibility.AccessibleSelection#removeAccessibleSelection(int)
     */
    public void removeAccessibleSelection(int i)
    {
      deselect(i);
    }

    /* (non-Javadoc)
     * @see javax.accessibility.AccessibleSelection#clearAccessibleSelection()
     */
    public void clearAccessibleSelection()
    {
      for (int i = 0; i < getItemCount(); i++)
        deselect(i);
    }

    /* (non-Javadoc)
     * @see javax.accessibility.AccessibleSelection#selectAllAccessibleSelection()
     */
    public void selectAllAccessibleSelection()
    {
      if (isMultipleMode())
        for (int i = 0; i < getItemCount(); i++)
          select(i);
    }

    /* (non-Javadoc)
     * @see java.awt.event.ItemListener#itemStateChanged(java.awt.event.ItemEvent)
     */
    public void itemStateChanged(ItemEvent event)
    {
    }

    /* (non-Javadoc)
     * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
     */
    public void actionPerformed(ActionEvent event)
    {
    }
1191

Tom Tromey committed
1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206
  }

  /**
   * Gets the AccessibleContext associated with this <code>List</code>.
   * The context is created, if necessary.
   *
   * @return the associated context
   */
  public AccessibleContext getAccessibleContext()
  {
    /* Create the context if this is the first request */
    if (accessibleContext == null)
      accessibleContext = new AccessibleAWTList();
    return accessibleContext;
  }
1207

1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221
  /**
   * Generate a unique name for this <code>List</code>.
   *
   * @return A unique name for this <code>List</code>.
   */
  String generateName()
  {
    return "list" + getUniqueLong();
  }

  private static synchronized long getUniqueLong()
  {
    return next_list_number++;
  }
Tom Tromey committed
1222
} // class List