Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Added missing JavaDoc.
Signed-off-by: Rajarshi  Guha <rajarshi.guha@gmail.com>
  • Loading branch information
egonw authored and rajarshi committed Nov 24, 2011
1 parent 284ff84 commit e316210
Showing 1 changed file with 32 additions and 19 deletions.
51 changes: 32 additions & 19 deletions src/main/org/openscience/cdk/controller/IMouseEventRelay.java
@@ -1,6 +1,5 @@
/* $Revision$ $Author$ $Date$
*
* Copyright (C) 2007 Niels Out <nielsout@users.sf.net>
/* Copyright (C) 2007 Niels Out <nielsout@users.sf.net>
* 2011 Egon Willighagen <egonw@users.sf.net>
*
* Contact: cdk-devel@lists.sourceforge.net or nout@science.uva.nl
*
Expand All @@ -25,52 +24,66 @@
package org.openscience.cdk.controller;

/**
* Widget toolkit-independent interface to relay for mouse events.
*
* @cdk.module control
*/
public interface IMouseEventRelay {

/**
* Event to signal that a mouse button has been released.
*
* @param screenCoordX
* @param screenCoordY
* @param screenCoordX the x part of the screen coordinate where the event happened.
* @param screenCoordY the y part of the screen coordinate where the event happened.
*/
public abstract void mouseClickedUp(int screenCoordX, int screenCoordY);

/**
* Event to signal that a mouse button has been pushed but not released yet.
*
* @param screenCoordX
* @param screenCoordY
* @param screenCoordX the x part of the screen coordinate where the event happened.
* @param screenCoordY the y part of the screen coordinate where the event happened.
*/
public abstract void mouseClickedDown(int screenCoordX, int screenCoordY);

/**
* Event to signal that a mouse button has been double clicked.
*
* @param screenCoordX
* @param screenCoordY
* @param screenCoordX the x part of the screen coordinate where the event happened.
* @param screenCoordY the y part of the screen coordinate where the event happened.
*/
public abstract void mouseClickedDouble(int screenCoordX, int screenCoordY);

/**
* Event to signal that a mouse has been moved to the new coordinates.
*
* @param screenCoordX
* @param screenCoordY
* @param screenCoordX the x part of the latest screen coordinate.
* @param screenCoordY the y part of the latest screen coordinate.
*/
public abstract void mouseMove(int screenCoordX, int screenCoordY);

/**
*
* @param screenCoordX
* @param screenCoordY
* @param screenCoordX
* @param screenCoordY
*/
public abstract void mouseEnter(int screenCoordX, int screenCoordY);

/**
*
* @param screenCoordX
* @param screenCoordY
* @param screenCoordX
* @param screenCoordY
*/
public abstract void mouseExit(int screenCoordX, int screenCoordY);

/**
* Event to signal that a mouse has been dragged from one point to
* a next.
*
* @param screenCoordXFrom
* @param screenCoordYFrom
* @param screenCoordXTo
* @param screenCoordYTo
* @param screenCoordXFrom the x part of the screen coordinate dragged from.
* @param screenCoordYFrom the y part of the screen coordinate dragged from.
* @param screenCoordXTo the x part of the screen coordinate dragged to.
* @param screenCoordYTo the y part of the screen coordinate dragged to.
*/
public abstract void mouseDrag(int screenCoordXFrom, int screenCoordYFrom, int screenCoordXTo, int screenCoordYTo);

Expand Down

0 comments on commit e316210

Please sign in to comment.