com.anrisoftware.prefdialog.miscswing.lists.ActionList Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of prefdialog-misc-swing Show documentation
Miscellaneous swing components.
The newest version!
/*
 * Copyright 2013-2016 Erwin Müller 
 *
 * This file is part of prefdialog-misc-swing.
 *
 * prefdialog-misc-swing is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * prefdialog-misc-swing 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 Lesser General Public License
 * along with prefdialog-misc-swing. If not, see .
 */
package com.anrisoftware.prefdialog.miscswing.lists;

import static java.awt.event.ActionEvent.ACTION_PERFORMED;

import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.KeyAdapter;
import java.awt.event.KeyEvent;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;

import javax.swing.JList;
import javax.swing.event.ListSelectionEvent;
import javax.swing.event.ListSelectionListener;

import org.apache.commons.lang3.event.EventListenerSupport;

/**
 * Decorates a swing list so that the added action listeners are informed if the
 * user select an item. The action listeners can be informed multiple times with
 * the same list item, so caution must be taken.
 *
 * @author Erwin Mueller, [email protected]
 * @since 1.0
 */
public class ActionList {

    /**
     * @see #decorate(JList)
     */
    public static  ActionList createActionList(JList list) {
        return decorate(list);
    }

    /**
     * Create the action list from the specified list.
     *
     * @param list
     *            the {@link JList}.
     *
     * @return the new {@link ActionList}.
     */
    public static  ActionList decorate(JList list) {
        return new ActionList(list);
    }

    private final EventListenerSupport actionListeners;

    private final JList list;

    private String command;

    /**
     * @see #decorate(JList)
     */
    ActionList(JList list) {
        this.actionListeners = new EventListenerSupport(
                ActionListener.class);
        this.list = list;
        setupList();
    }

    private void setupList() {
        list.getSelectionModel().addListSelectionListener(
                new ListSelectionListener() {

                    @Override
                    public void valueChanged(ListSelectionEvent e) {
                        if (!e.getValueIsAdjusting()) {
                            fireAction();
                        }
                    }
                });
        list.addMouseListener(new MouseAdapter() {
            @Override
            public void mouseClicked(MouseEvent e) {
                fireAction();
            }
        });
        list.addKeyListener(new KeyAdapter() {
            @Override
            public void keyPressed(KeyEvent e) {
                if (e.getExtendedKeyCode() == KeyEvent.VK_SPACE) {
                    fireAction();
                }
                if (e.getExtendedKeyCode() == KeyEvent.VK_ENTER) {
                    fireAction();
                }
            }
        });
    }

    private void fireAction() {
        actionListeners.fire().actionPerformed(
                new ActionEvent(list, ACTION_PERFORMED, command));
    }

    /**
     * Returns the decorated list.
     *
     * @return the {@link JList}.
     */
    public JList getList() {
        return list;
    }

    /**
     * Sets the action command string that is returned in the action event.
     *
     * @param command
     *            the action command string.
     *
     * @see ActionEvent#getActionCommand()
     */
    public void setActionCommand(String command) {
        this.command = command;
    }

    /**
     * Returns the action command string that is returned in the action event.
     *
     * @return the action command string.
     *
     * @see ActionEvent#getActionCommand()
     */
    public String getActionCommand() {
        return command;
    }

    /**
     * Adds the action listener that is informed if the user select an item.
     *
     * @param l
     *            the {@link ActionListener}.
     */
    public void addActionListener(ActionListener l) {
        actionListeners.addListener(l);
    }

    /**
     * Removes an old action listener.
     *
     * @param l
     *            the {@link ActionListener}.
     */
    public void removeActionListener(ActionListener l) {
        actionListeners.removeListener(l);
    }
}