net.sf.mmm.client.ui.gwt.widgets.handler

Class AbstractMouseDragHandler

java.lang.Object

net.sf.mmm.client.ui.gwt.widgets.handler.AbstractMouseDragHandler

All Implemented Interfaces:

com.google.gwt.event.dom.client.MouseDownHandler, com.google.gwt.event.dom.client.MouseMoveHandler, com.google.gwt.event.dom.client.MouseUpHandler, com.google.gwt.event.shared.EventHandler, com.google.gwt.user.client.Event.NativePreviewHandler, AbstractCustomHandler

Direct Known Subclasses:

PopupMouseHandler, UiWidgetAdapterGwtTableColumn.ResizeHandler

public abstract class AbstractMouseDragHandler
extends Object
implements com.google.gwt.event.dom.client.MouseDownHandler, com.google.gwt.event.dom.client.MouseUpHandler, com.google.gwt.event.dom.client.MouseMoveHandler, com.google.gwt.user.client.Event.NativePreviewHandler, AbstractCustomHandler

This is the abstract base class for a handler that allows moving or resizing with the mouse.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private int	mouseX The initial x position while dragging the mouse.
private int	mouseY The initial y position while dragging the mouse.
private com.google.gwt.event.shared.HandlerRegistration	registration The HandlerRegistration for the global mouse-listener registration while dragging or null.

Constructor Summary

Constructors

Constructor and Description
AbstractMouseDragHandler() The constructor.

Method Summary

Modifier and Type	Method and Description
int	getMouseX()
int	getMouseY()
protected void	initializeOnMouseDown(com.google.gwt.event.dom.client.MouseDownEvent event) Override to add initialization logic to onMouseDown(MouseDownEvent).
protected boolean	isActive() This method can be overridden for dynamic activation of this handler.
void	onMouseDown(com.google.gwt.event.dom.client.MouseDownEvent event)
protected abstract void	onMouseMove(int deltaX, int deltaY, com.google.gwt.dom.client.NativeEvent nativeEvent)
void	onMouseMove(com.google.gwt.event.dom.client.MouseMoveEvent event)
void	onMouseUp(com.google.gwt.event.dom.client.MouseUpEvent event)
void	onPreviewNativeEvent(com.google.gwt.user.client.Event.NativePreviewEvent event)
void	register(com.google.gwt.user.client.ui.Widget widget, HandlerRegistrationCollector collector) This method registers this custom handler in the given Widget.

Methods inherited from class java.lang.Object

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

Field Detail

mouseX

private int mouseX

The initial x position while dragging the mouse.

mouseY

private int mouseY

The initial y position while dragging the mouse.

registration

private com.google.gwt.event.shared.HandlerRegistration registration

The HandlerRegistration for the global mouse-listener registration while dragging or null.

Constructor Detail

AbstractMouseDragHandler

public AbstractMouseDragHandler()

The constructor.

Method Detail

getMouseX

public int getMouseX()

Returns:

the mouseX

getMouseY

public int getMouseY()

Returns:

the mouseY

isActive

protected boolean isActive()

This method can be overridden for dynamic activation of this handler.

Returns:

true if this handler is active, false if it is inactive (ignores all events and does nothing).

onMouseDown

public final void onMouseDown(com.google.gwt.event.dom.client.MouseDownEvent event)

Specified by:

onMouseDown in interface com.google.gwt.event.dom.client.MouseDownHandler

initializeOnMouseDown

protected void initializeOnMouseDown(com.google.gwt.event.dom.client.MouseDownEvent event)

Override to add initialization logic to onMouseDown(MouseDownEvent).

Parameters:

event - is the initial MouseDownEvent.

onPreviewNativeEvent

public void onPreviewNativeEvent(com.google.gwt.user.client.Event.NativePreviewEvent event)

Specified by:

onPreviewNativeEvent in interface com.google.gwt.user.client.Event.NativePreviewHandler

onMouseMove

public void onMouseMove(com.google.gwt.event.dom.client.MouseMoveEvent event)

Specified by:

onMouseMove in interface com.google.gwt.event.dom.client.MouseMoveHandler

onMouseMove

protected abstract void onMouseMove(int deltaX,
                                    int deltaY,
                                    com.google.gwt.dom.client.NativeEvent nativeEvent)

Parameters:

deltaX - is the relative movement of the mouse position on X-axis.

deltaY - is the relative movement of the mouse position on Y-axis.

nativeEvent - is the NativeEvent that triggered this invocation.

See Also:

onMouseMove(MouseMoveEvent)

onMouseUp

public void onMouseUp(com.google.gwt.event.dom.client.MouseUpEvent event)

Specified by:

onMouseUp in interface com.google.gwt.event.dom.client.MouseUpHandler

register

public void register(com.google.gwt.user.client.ui.Widget widget,
                     HandlerRegistrationCollector collector)

This method registers this custom handler in the given Widget. It will also ensure that the Widget is properly configured to send the required events (e.g. via sends).

Specified by:

register in interface AbstractCustomHandler

Parameters:

widget - is the Widget where to register this handler.

collector - is the HandlerRegistrationCollector where to collect the HandlerRegistration(s) of the registered handlers. May be null to ignore all registrations.