fr.inria.zvtm.event
Interface ViewListener

All Known Implementing Classes:

ScrollingListener, SlaveApp.SlaveEventHandler, SwingListener, ViewAdapter

public interface ViewListener

Interface to handle events happening in a View.

Author:

Emmanuel Pietriga

Field Summary

static int	ALT_MOD Alt key modifier depressed.
static int	ALT_SHIFT_MOD Both Shift and Alt key modifiers depressed.
static int	CTRL_MOD Control key modifier depressed.
static int	CTRL_SHIFT_MOD Both Control and Shift key modifiers depressed.
static int	META_MOD Meta/Command key modifier depressed.
static int	META_SHIFT_MOD Both Shift and Meta/Command key modifiers depressed.
static int	NO_MODIFIER No key modifier depressed.
static int	SHIFT_MOD Shift key modifier depressed.
static short	WHEEL_DOWN Mouse wheel down event.
static short	WHEEL_UP Mouse wheel up event.

Method Summary

void	click1(ViewPanel v, int mod, int jpx, int jpy, int clickNumber, MouseEvent e) Left mouse button clicked callback.
void	click2(ViewPanel v, int mod, int jpx, int jpy, int clickNumber, MouseEvent e) Middle mouse button clicked callback.
void	click3(ViewPanel v, int mod, int jpx, int jpy, int clickNumber, MouseEvent e) Right mouse button clicked callback.
void	enterGlyph(Glyph g) Cursor entered glyph callback.
void	exitGlyph(Glyph g) Cursor exited glyph callback.
void	Kpress(ViewPanel v, char c, int code, int mod, KeyEvent e) Key pressed event.
void	Krelease(ViewPanel v, char c, int code, int mod, KeyEvent e) Key released event.
void	Ktype(ViewPanel v, char c, int code, int mod, KeyEvent e) Key typed event.
void	mouseDragged(ViewPanel v, int mod, int buttonNumber, int jpx, int jpy, MouseEvent e) Mouse dragged callback.
void	mouseMoved(ViewPanel v, int jpx, int jpy, MouseEvent e) Mouse moved callback.
void	mouseWheelMoved(ViewPanel v, short wheelDirection, int jpx, int jpy, MouseWheelEvent e) Mouse wheel moved callback.
void	press1(ViewPanel v, int mod, int jpx, int jpy, MouseEvent e) Left mouse button pressed callback.
void	press2(ViewPanel v, int mod, int jpx, int jpy, MouseEvent e) Middle mouse button pressed callback.
void	press3(ViewPanel v, int mod, int jpx, int jpy, MouseEvent e) Right mouse button pressed callback.
void	release1(ViewPanel v, int mod, int jpx, int jpy, MouseEvent e) Left mouse button released callback.
void	release2(ViewPanel v, int mod, int jpx, int jpy, MouseEvent e) Middle mouse button released callback.
void	release3(ViewPanel v, int mod, int jpx, int jpy, MouseEvent e) Right mouse button released callback.
void	viewActivated(View v) View activated.
void	viewClosing(View v) View closing.
void	viewDeactivated(View v) View deactivated.
void	viewDeiconified(View v) View deiconified.
void	viewIconified(View v) View iconified.

Field Detail

NO_MODIFIER

static final int NO_MODIFIER

No key modifier depressed.

See Also:

Constant Field Values

SHIFT_MOD

static final int SHIFT_MOD

Shift key modifier depressed.

See Also:

Constant Field Values

CTRL_MOD

static final int CTRL_MOD

Control key modifier depressed.

See Also:

Constant Field Values

CTRL_SHIFT_MOD

static final int CTRL_SHIFT_MOD

Both Control and Shift key modifiers depressed.

See Also:

Constant Field Values

META_MOD

static final int META_MOD

Meta/Command key modifier depressed.

See Also:

Constant Field Values

META_SHIFT_MOD

static final int META_SHIFT_MOD

Both Shift and Meta/Command key modifiers depressed.

See Also:

Constant Field Values

ALT_MOD

static final int ALT_MOD

Alt key modifier depressed.

See Also:

Constant Field Values

ALT_SHIFT_MOD

static final int ALT_SHIFT_MOD

Both Shift and Alt key modifiers depressed.

See Also:

Constant Field Values

WHEEL_UP

static final short WHEEL_UP

Mouse wheel up event.

See Also:

Constant Field Values

WHEEL_DOWN

static final short WHEEL_DOWN

Mouse wheel down event.

See Also:

Constant Field Values

Method Detail

press1

void press1(ViewPanel v,
            int mod,
            int jpx,
            int jpy,
            MouseEvent e)

Left mouse button pressed callback.

Parameters:

v - ViewPanel/JPanel embedded in View, on which glyphs are drawn.

mod - key modifiers depressed when event occured. One of NO_MODIFIER, SHIFT_MOD, CTRL_MOD, CTRL_SHIFT_MOD, META_MOD, META_SHIFT_MOD, ALT_MOD, ALT_SHIFT_MOD.

jpx - x-coordinate of cursor in JPanel coordinates when event occured.

jpy - y-coordinate of cursor in JPanel coordinates when event occured.

e - reference to original AWT mouse event.

release1

void release1(ViewPanel v,
              int mod,
              int jpx,
              int jpy,
              MouseEvent e)

Left mouse button released callback.

Parameters:

v - ViewPanel/JPanel embedded in View, on which glyphs are drawn.

mod - key modifiers depressed when event occured. One of NO_MODIFIER, SHIFT_MOD, CTRL_MOD, CTRL_SHIFT_MOD, META_MOD, META_SHIFT_MOD, ALT_MOD, ALT_SHIFT_MOD.

jpx - x-coordinate of cursor in JPanel coordinates when event occured.

jpy - y-coordinate of cursor in JPanel coordinates when event occured.

e - reference to original AWT mouse event.

click1

void click1(ViewPanel v,
            int mod,
            int jpx,
            int jpy,
            int clickNumber,
            MouseEvent e)

Left mouse button clicked callback.

Parameters:

v - ViewPanel/JPanel embedded in View, on which glyphs are drawn.

mod - key modifiers depressed when event occured. One of NO_MODIFIER, SHIFT_MOD, CTRL_MOD, CTRL_SHIFT_MOD, META_MOD, META_SHIFT_MOD, ALT_MOD, ALT_SHIFT_MOD.

jpx - x-coordinate of cursor in JPanel coordinates when event occured.

jpy - y-coordinate of cursor in JPanel coordinates when event occured.

e - reference to original AWT mouse event.

press2

void press2(ViewPanel v,
            int mod,
            int jpx,
            int jpy,
            MouseEvent e)

Middle mouse button pressed callback.

Parameters:

v - ViewPanel/JPanel embedded in View, on which glyphs are drawn.

mod - key modifiers depressed when event occured. One of NO_MODIFIER, SHIFT_MOD, CTRL_MOD, CTRL_SHIFT_MOD, META_MOD, META_SHIFT_MOD, ALT_MOD, ALT_SHIFT_MOD.

jpx - x-coordinate of cursor in JPanel coordinates when event occured.

jpy - y-coordinate of cursor in JPanel coordinates when event occured.

e - reference to original AWT mouse event.

release2

void release2(ViewPanel v,
              int mod,
              int jpx,
              int jpy,
              MouseEvent e)

Middle mouse button released callback.

Parameters:

v - ViewPanel/JPanel embedded in View, on which glyphs are drawn.

mod - key modifiers depressed when event occured. One of NO_MODIFIER, SHIFT_MOD, CTRL_MOD, CTRL_SHIFT_MOD, META_MOD, META_SHIFT_MOD, ALT_MOD, ALT_SHIFT_MOD.

jpx - x-coordinate of cursor in JPanel coordinates when event occured.

jpy - y-coordinate of cursor in JPanel coordinates when event occured.

e - reference to original AWT mouse event.

click2

void click2(ViewPanel v,
            int mod,
            int jpx,
            int jpy,
            int clickNumber,
            MouseEvent e)

Middle mouse button clicked callback.

Parameters:

v - ViewPanel/JPanel embedded in View, on which glyphs are drawn.

mod - key modifiers depressed when event occured. One of NO_MODIFIER, SHIFT_MOD, CTRL_MOD, CTRL_SHIFT_MOD, META_MOD, META_SHIFT_MOD, ALT_MOD, ALT_SHIFT_MOD.

jpx - x-coordinate of cursor in JPanel coordinates when event occured.

jpy - y-coordinate of cursor in JPanel coordinates when event occured.

e - reference to original AWT mouse event.

press3

void press3(ViewPanel v,
            int mod,
            int jpx,
            int jpy,
            MouseEvent e)

Right mouse button pressed callback.

Parameters:

v - ViewPanel/JPanel embedded in View, on which glyphs are drawn.

mod - key modifiers depressed when event occured. One of NO_MODIFIER, SHIFT_MOD, CTRL_MOD, CTRL_SHIFT_MOD, META_MOD, META_SHIFT_MOD, ALT_MOD, ALT_SHIFT_MOD.

jpx - x-coordinate of cursor in JPanel coordinates when event occured.

jpy - y-coordinate of cursor in JPanel coordinates when event occured.

e - reference to original AWT mouse event.

release3

void release3(ViewPanel v,
              int mod,
              int jpx,
              int jpy,
              MouseEvent e)

Right mouse button released callback.

Parameters:

v - ViewPanel/JPanel embedded in View, on which glyphs are drawn.

mod - key modifiers depressed when event occured. One of NO_MODIFIER, SHIFT_MOD, CTRL_MOD, CTRL_SHIFT_MOD, META_MOD, META_SHIFT_MOD, ALT_MOD, ALT_SHIFT_MOD.

jpx - x-coordinate of cursor in JPanel coordinates when event occured.

jpy - y-coordinate of cursor in JPanel coordinates when event occured.

e - reference to original AWT mouse event.

click3

void click3(ViewPanel v,
            int mod,
            int jpx,
            int jpy,
            int clickNumber,
            MouseEvent e)

Right mouse button clicked callback.

Parameters:

v - ViewPanel/JPanel embedded in View, on which glyphs are drawn.

mod - key modifiers depressed when event occured. One of NO_MODIFIER, SHIFT_MOD, CTRL_MOD, CTRL_SHIFT_MOD, META_MOD, META_SHIFT_MOD, ALT_MOD, ALT_SHIFT_MOD.

jpx - x-coordinate of cursor in JPanel coordinates when event occured.

jpy - y-coordinate of cursor in JPanel coordinates when event occured.

e - reference to original AWT mouse event.

mouseMoved

void mouseMoved(ViewPanel v,
                int jpx,
                int jpy,
                MouseEvent e)

Mouse moved callback. This callback can be enabled/disabled using View.setNotifyCursorMoved(). Active by default.

Parameters:

v - ViewPanel/JPanel embedded in View, on which glyphs are drawn.

jpx - x-coordinate of cursor in JPanel coordinates when event occured.

jpy - y-coordinate of cursor in JPanel coordinates when event occured.

e - reference to original AWT mouse event.

See Also:

View.setNotifyCursorMoved(boolean b)

mouseDragged

void mouseDragged(ViewPanel v,
                  int mod,
                  int buttonNumber,
                  int jpx,
                  int jpy,
                  MouseEvent e)

Mouse dragged callback.

Parameters:

v - ViewPanel/JPanel embedded in View, on which glyphs are drawn.

mod - key modifiers depressed when event occured. One of NO_MODIFIER, SHIFT_MOD, CTRL_MOD, CTRL_SHIFT_MOD, META_MOD, META_SHIFT_MOD, ALT_MOD, ALT_SHIFT_MOD.

buttonNumber - one of 1 (left), 2 (middle) or 3 (right)

jpx - x-coordinate of cursor in JPanel coordinates when event occured.

jpy - y-coordinate of cursor in JPanel coordinates when event occured.

e - reference to original AWT mouse event.

mouseWheelMoved

void mouseWheelMoved(ViewPanel v,
                     short wheelDirection,
                     int jpx,
                     int jpy,
                     MouseWheelEvent e)

Mouse wheel moved callback.

Parameters:

v - ViewPanel/JPanel embedded in View, on which glyphs are drawn.

wheelDirection - is one of WHEEL_UP, WHEEL_DOWN

jpx - x-coordinate of cursor in JPanel coordinates when event occured.

jpy - y-coordinate of cursor in JPanel coordinates when event occured.

e - reference to original AWT mouse event.

enterGlyph

void enterGlyph(Glyph g)

Cursor entered glyph callback.

Parameters:

g - Glyph instance the cursor just entered

exitGlyph

void exitGlyph(Glyph g)

Cursor exited glyph callback.

Parameters:

g - Glyph instance the cursor just exited

Ktype

void Ktype(ViewPanel v,
           char c,
           int code,
           int mod,
           KeyEvent e)

Key typed event. Beware: code is always 0 in Ktype (it is the value of KeyEvent.getKeyCode() which is always equal to VK_UNDEFINED according to Sun). If you need to access code, use Kpress or Krelease.

Parameters:

v - ViewPanel/JPanel embedded in View, on which glyphs are drawn.

c - char typed.

code - code of key typed (value of KeyEvent.getKeyCode()).

mod - key modifiers depressed when event occured. One of NO_MODIFIER, SHIFT_MOD, CTRL_MOD, CTRL_SHIFT_MOD, META_MOD, META_SHIFT_MOD, ALT_MOD, ALT_SHIFT_MOD.

e - reference to original AWT mouse event.

Kpress

void Kpress(ViewPanel v,
            char c,
            int code,
            int mod,
            KeyEvent e)

Key pressed event.

Parameters:

v - ViewPanel/JPanel embedded in View, on which glyphs are drawn.

c - char typed.

code - code of key typed (value of KeyEvent.getKeyCode()).

mod - key modifiers depressed when event occured. One of NO_MODIFIER, SHIFT_MOD, CTRL_MOD, CTRL_SHIFT_MOD, META_MOD, META_SHIFT_MOD, ALT_MOD, ALT_SHIFT_MOD.

e - reference to original AWT mouse event.

Krelease

void Krelease(ViewPanel v,
              char c,
              int code,
              int mod,
              KeyEvent e)

Key released event.

Parameters:

v - ViewPanel/JPanel embedded in View, on which glyphs are drawn.

c - char typed.

code - code of key typed (value of KeyEvent.getKeyCode()).

mod - key modifiers depressed when event occured. One of NO_MODIFIER, SHIFT_MOD, CTRL_MOD, CTRL_SHIFT_MOD, META_MOD, META_SHIFT_MOD, ALT_MOD, ALT_SHIFT_MOD.

e - reference to original AWT mouse event.

viewActivated

void viewActivated(View v)

View activated.

viewDeactivated

void viewDeactivated(View v)

View deactivated.

viewIconified

void viewIconified(View v)

View iconified.

viewDeiconified

void viewDeiconified(View v)

View deiconified.

viewClosing

void viewClosing(View v)

View closing.