com.inductiveautomation.ignition.client.util.gui

Class CommonMouseAdapter

java.lang.Object

com.inductiveautomation.ignition.client.util.gui.MouseAdapterEx

com.inductiveautomation.ignition.client.util.gui.CommonMouseAdapter

All Implemented Interfaces:

java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.util.EventListener

public abstract class CommonMouseAdapter
extends MouseAdapterEx

This mouse listener and mouse motion listener implements logic to make handling mouse drags easier. It handles logic such converting "trivial drags" into clicks, meaning that drags must exceed a minimum drag distance before being considered a "drag". It also has simple popup trigger handling and other conveniences.

Field Summary

Fields

Modifier and Type	Field and Description
static double	MIN_DRAG_DIST

Constructor Summary

Constructors

Constructor and Description
CommonMouseAdapter()

Method Summary

Modifier and Type	Method and Description
protected double	getMinDragDistance() The minimum distance before a drag starts.
void	mouseDragged(java.awt.event.MouseEvent e)
void	mouseMoved(java.awt.event.MouseEvent e)
void	mousePressed(java.awt.event.MouseEvent e)
void	mouseReleased(java.awt.event.MouseEvent e)
protected void	onClick(java.awt.event.MouseEvent event, java.awt.Point point, int modifiers)
protected void	onDrag(java.awt.event.MouseEvent event, java.awt.Point start, java.awt.Point end, java.awt.Rectangle rect, int modifiers)
protected void	onDragEnd(java.awt.event.MouseEvent event, java.awt.Point start, java.awt.Point end, java.awt.Rectangle rect, int modifiers)
protected void	onDragStart(java.awt.event.MouseEvent event, java.awt.Point start, java.awt.Point end, java.awt.Rectangle rect, int modifiers)
protected void	onMove(java.awt.event.MouseEvent event, java.awt.Point point, int modifiers)
protected void	onPopupTrigger(java.awt.event.MouseEvent event, java.awt.Point point, int modifiers)
protected void	onPress(java.awt.event.MouseEvent event, java.awt.Point point, int modifiers)
protected void	onRelease(java.awt.event.MouseEvent event, java.awt.Point point, int modifiers)
protected boolean	process(java.awt.event.MouseEvent e) Determines if this mouse event should be processed or not.

Methods inherited from class com.inductiveautomation.ignition.client.util.gui.MouseAdapterEx

install, mouseClicked, mouseEntered, mouseExited, uninstall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MIN_DRAG_DIST

public static final double MIN_DRAG_DIST

See Also:

Constant Field Values

Constructor Detail

CommonMouseAdapter

public CommonMouseAdapter()

Method Detail

process

protected boolean process(java.awt.event.MouseEvent e)

Determines if this mouse event should be processed or not. Default implementation does not process consumed mouse events

getMinDragDistance

protected double getMinDragDistance()

The minimum distance before a drag starts. Default is 4.0

mousePressed

public void mousePressed(java.awt.event.MouseEvent e)

Specified by:

mousePressed in interface java.awt.event.MouseListener

Overrides:

mousePressed in class MouseAdapterEx

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)

Specified by:

mouseReleased in interface java.awt.event.MouseListener

Overrides:

mouseReleased in class MouseAdapterEx

mouseMoved

public void mouseMoved(java.awt.event.MouseEvent e)

Specified by:

mouseMoved in interface java.awt.event.MouseMotionListener

Overrides:

mouseMoved in class MouseAdapterEx

mouseDragged

public void mouseDragged(java.awt.event.MouseEvent e)

Specified by:

mouseDragged in interface java.awt.event.MouseMotionListener

Overrides:

mouseDragged in class MouseAdapterEx

onDragStart

protected void onDragStart(java.awt.event.MouseEvent event,
                           java.awt.Point start,
                           java.awt.Point end,
                           java.awt.Rectangle rect,
                           int modifiers)

onDrag

protected void onDrag(java.awt.event.MouseEvent event,
                      java.awt.Point start,
                      java.awt.Point end,
                      java.awt.Rectangle rect,
                      int modifiers)

onDragEnd

protected void onDragEnd(java.awt.event.MouseEvent event,
                         java.awt.Point start,
                         java.awt.Point end,
                         java.awt.Rectangle rect,
                         int modifiers)

onMove

protected void onMove(java.awt.event.MouseEvent event,
                      java.awt.Point point,
                      int modifiers)

onPress

protected void onPress(java.awt.event.MouseEvent event,
                       java.awt.Point point,
                       int modifiers)

onRelease

protected void onRelease(java.awt.event.MouseEvent event,
                         java.awt.Point point,
                         int modifiers)

onPopupTrigger

protected void onPopupTrigger(java.awt.event.MouseEvent event,
                              java.awt.Point point,
                              int modifiers)

onClick

protected void onClick(java.awt.event.MouseEvent event,
                       java.awt.Point point,
                       int modifiers)