edu.uci.ics.jung.visualization.control.GraphMousePlugin Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2005, The JUNG Authors
 * All rights reserved.
 *
 * This software is open-source under the BSD license; see either "license.txt"
 * or https://github.com/jrtom/jung/blob/master/LICENSE for a description.
 *
 * Created on Jul 6, 2005
 */

package edu.uci.ics.jung.visualization.control;

import java.awt.event.MouseEvent;

/**
 * the interface for all plugins to the PluggableGraphMouse
 *
 * @author Tom Nelson
 */
public interface GraphMousePlugin {

  /** @return the mouse event modifiers that will activate this plugin */
  int getModifiers();

  /** @param modifiers the mouse event modifiers that will activate this plugin */
  void setModifiers(int modifiers);

  /**
   * compare the set modifiers against those of the supplied event
   *
   * @param e an event to compare to
   * @return whether the member modifiers match the event modifiers
   */
  boolean checkModifiers(MouseEvent e);
}