/* ----------------------------------------------------------------------------
   The Kiwi Toolkit - A Java Class Library
   Copyright (C) 1998-2004 Mark A. Lindner

   This library 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 of the
   License, or (at your option) any later version.

   This library 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 this library; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
   02111-1307, USA.
 
   The author may be contacted at: mark_a_lindner@yahoo.com
   ----------------------------------------------------------------------------
   $Log: UIElementChooser.java,v $
   Revision 1.6  2004/05/12 18:53:25  markl
   comment block updates

   Revision 1.5  2003/01/19 09:46:48  markl
   replaced JScrollPane instances with KScrollPane.

   Revision 1.4  2001/03/12 09:28:01  markl
   Source code and Javadoc cleanup.

   Revision 1.3  1999/07/06 09:17:31  markl
   Added requestFocus() method.

   Revision 1.2  1999/07/05 08:20:15  markl
   Added methods to set/get the selection.

   Revision 1.1  1999/05/10 09:12:18  markl
   Initial revision
   ----------------------------------------------------------------------------
*/

package kiwi.ui;

import java.awt.*;
import java.util.*;
import javax.swing.*;
import javax.swing.border.*;
import javax.swing.event.*;

/** A chooser component for <code>UIElement</code>s. The component consists of
 * a scrollable list box to the right of a display area which is used to
 * display the currently-selected element.
 *
  * <p><center>
  * <img src="snapshot/UIElementChooser.gif"><br>
  * <i>An example UIElementChooser (using a TextureViewer).</i>
  * </center>
 *
 * @author Mark Lindner
 */

public class UIElementChooser extends KPanel
  {
  private UIElementViewer elementViewer = null;
  private DefaultListModel model;
  private JList jlist;
  private _ListSelectionListener selListener;
  private KPanel viewpane;
  private static final BevelBorder border
    = new BevelBorder(BevelBorder.LOWERED);

  /** Construct a new <code>UIElementChooser</code> with the specified viewer
   * and element list.
   *
   * @param viewer A viewer component for displaying the element.
   * @param list A Vector of elements that can be picked from.
   */
  
  public UIElementChooser(UIElementViewer viewer, Vector list)
    {
    this();

    setElementViewer(viewer);
    setElementList(list);
    }

  /** Construct a new <code>UIElementChooser</code>.
   */
  
  public UIElementChooser()
    {
    setLayout(new BorderLayout(5, 5));

    jlist = new JList();
    jlist.setModel(model = new DefaultListModel());
    jlist.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
    add("East", new KScrollPane(jlist));

    selListener = new _ListSelectionListener();
    jlist.addListSelectionListener(selListener);

    viewpane = new KPanel();
    viewpane.setLayout(new GridLayout(1, 0));
    viewpane.setBorder(border);
    add("Center", viewpane);
    }

  /** Set the viewer component to be used to display elements.
   *
   * @param viewer The new viewer.
   */
  
  public void setElementViewer(UIElementViewer viewer)
    {
    if(elementViewer != null)
      viewpane.remove(elementViewer.getViewerComponent());

    JComponent c = viewer.getViewerComponent();
    viewpane.add(c);
    elementViewer = viewer;
    c.invalidate();
    validate();
    }

  /** Set the list of elements to allow selection from.
   *
   * @param list The list of elements.
   */
  
  public void setElementList(Vector list)
    {
    model.removeAllElements();

    Enumeration e = list.elements();
    while(e.hasMoreElements())
      model.addElement(e.nextElement());

    if(model.getSize() > 0)
      jlist.setSelectedIndex(0);

    if(elementViewer != null)
      {
      Object elem = null;
      if(model.getSize() > 0)
        elem = model.getElementAt(0);
      }
    }

  /** Get the currently selected item.
   *
   * @return The currently selected <code>UIElement</code>, or
   * <code>null</code> if there is no selection.
   */
  
  public UIElement getSelectedItem()
    {
    return((UIElement)jlist.getSelectedValue());
    }

  /** Set the currently selected item.
   *
   * @param element The <code>UIElement</code> to select.
   */
  
  public void setSelectedItem(UIElement element)
    {
    jlist.setSelectedValue(element, true);
    }

  /** Set the currently selected item by name.
   *
   * @param name The name of the element to select; the name of each
   * <code>UIElement</code> in the list is compared to the specified name; if
   * the names match, the corresponding item in the list is selected.
   *
   * @see kiwi.ui.UIElement#getName
   */
  
  public void setSelectedItem(String name)
    {
    for(int i = 0; i < model.getSize(); i++)
      {
      UIElement e = (UIElement)model.getElementAt(i);
      if(e.getName().equals(name))
        jlist.setSelectedIndex(i);
      }
    }

  /** Request focus for this component.
   */

  public void requestFocus()
    {
    jlist.requestFocus();
    }
  
  /** ListSelectionListener */
  
  private class _ListSelectionListener implements ListSelectionListener
    {
    public void valueChanged(ListSelectionEvent evt)
      {
      Object elem = jlist.getSelectedValue();
      if((elem != null) && (elementViewer != null))
        elementViewer.showElement((UIElement)elem);
      }
    }
  
  }

/* end of source file */