DialogList.java

/*
 * Copyright (C) 2014 Dr. John Lindsay <jlindsay@uoguelph.ca>
 *
 * This program 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 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 program.  If not, see <http://www.gnu.org/licenses/>.
 */
package whitebox.ui.plugin_dialog;

import java.awt.*;
import java.awt.event.*;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import javax.swing.event.ListSelectionEvent;
import javax.swing.event.ListSelectionListener;
import javax.swing.*;
import javax.swing.border.*;
import whitebox.interfaces.DialogComponent;

/**
 *
 * @author Dr. John Lindsay email: jlindsay@uoguelph.ca
 */
public class DialogList extends JPanel implements ActionListener, DialogComponent,
        PropertyChangeListener {

    private String name;
    private String description;
    private String value;
    private String label;
    private JLabel lbl = new JLabel();
    private JList list = new JList();
    private boolean multiSelect = true;

    private void createUI() {
        try {
            this.setLayout(new BoxLayout(this, BoxLayout.X_AXIS));
            Border border = BorderFactory.createEmptyBorder(5, 5, 5, 5);
            this.setBorder(border);
            JPanel panel = new JPanel();
            panel.setLayout(new BoxLayout(panel, BoxLayout.X_AXIS));

            Box box = Box.createVerticalBox();

            //list.addListSelectionListener(this);
            Box hbox = Box.createHorizontalBox();
            lbl = new JLabel(label);
            hbox.add(lbl);
            hbox.add(Box.createHorizontalGlue());
            box.add(hbox);
            box.add(Box.createHorizontalStrut(5));

            if (!multiSelect) {
                list.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
            } else { //true
                list.setSelectionMode(ListSelectionModel.MULTIPLE_INTERVAL_SELECTION);
            }

            ListSelectionListener listSelectionListener = new ListSelectionListener() {
                @Override
                public void valueChanged(ListSelectionEvent listSelectionEvent) {
                    raisePropertyChangedEvent("");
                }
            };
            list.addListSelectionListener(listSelectionListener);

            JScrollPane scroller1 = new JScrollPane(list);

            box.add(scroller1);
            box.setToolTipText(description);
            this.setToolTipText(description);
            list.setToolTipText(description);
            lbl.setToolTipText(description);
            panel.add(box);
            this.add(panel);
            //this.add(Box.createHorizontalGlue());

            this.setMaximumSize(new Dimension(2500, 95));
            this.setPreferredSize(new Dimension(350, 95));

        } catch (Exception e) {
            System.out.println(e.getCause());
        }
    }
    
    public void setListItems(String[] listItems) {
        list.setModel(new DefaultComboBoxModel(listItems));
        list.revalidate();
        list.repaint();
    }


    private void raisePropertyChangedEvent(String oldValue) {
        value = getValue();
        firePropertyChange("value", oldValue, value);
    }

    @Override
    public String getValue() {
        Object[] selectedValues = list.getSelectedValuesList().toArray();
        value = "";
        for (int i = 0; i < selectedValues.length; i++) {
            if (i < selectedValues.length - 1) {
                value = value + selectedValues[i].toString() + ";";
            } else {
                value = value + selectedValues[i].toString();
            }
        }
        return value.trim();
    }
    
    @Override
    public String getComponentName() {
        return name;
    }

    @Override
    public boolean getOptionalStatus() {
        return false;
    }

    @Override
    public boolean setArgs(String[] args) {
        try {
            // first make sure that there are the right number of args
            if (args.length != numArgs) {
                return false;
            }
            name = args[0];
            description = args[1];
            label = args[2];
            String[] listItems = args[3].split(",");
            for (int i = 0; i < listItems.length; i++) {
                listItems[i] = listItems[i].trim();
            }
            list = new JList(listItems);
            
            if (args[4].toLowerCase().contains("false")) {
                multiSelect = false;
                list.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
            } else { //true
                multiSelect = true;
                list.setSelectionMode(ListSelectionModel.MULTIPLE_INTERVAL_SELECTION);
            }
            createUI();
            return true;
        } catch (Exception e) {
            return false;
        }
    }

    private int numArgs = 5;

    @Override
    public String[] getArgsDescriptors() {
        String[] argsDescriptors = new String[numArgs];
        argsDescriptors[0] = "String name";
        argsDescriptors[1] = "String description";
        argsDescriptors[2] = "String label";
        argsDescriptors[3] = "String[] listItems";
        argsDescriptors[4] = "boolean allowMultipleSelection";
        return argsDescriptors;
    }

    @Override
    public void actionPerformed(ActionEvent e) {
        JComboBox cb = (JComboBox) e.getSource();
        value = (String) cb.getSelectedItem();
    }

    @Override
    public void propertyChange(PropertyChangeEvent evt) {
        raisePropertyChangedEvent("");
    }
    
    @Override
    public String getLabel() {
        return label;
    }

    @Override
    public void setLabel(String label) {
        this.label = label;
        lbl.setText(label);
    }
}