NodeClickEventListener.java

/*
Copyright 2008-2010 Gephi
Authors : Mathieu Bastian <mathieu.bastian@gephi.org>
Website : http://www.gephi.org

This file is part of Gephi.

Gephi is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

Gephi 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 Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with Gephi.  If not, see <http://www.gnu.org/licenses/>.
*/
package org.gephi.tools.spi;

import org.gephi.graph.api.Node;

/**
 * Tool node click listener. Listen to node click on the visualization window.
 * <p>
 * A tool whih declares this listener is notified when user click on nodes.
 *
 * @author Mathieu Bastian
 */
public interface NodeClickEventListener extends ToolEventListener {

    /**
     * Notify <code>nodes</code> have been clicked by user on the visualization window.
     * @param nodes the clicked nodes
     */
    public void clickNodes(Node[] nodes);
}