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

Class AbstractDragAndDropHandler

java.lang.Object

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

All Implemented Interfaces:

com.google.gwt.event.dom.client.DragEndHandler, com.google.gwt.event.dom.client.DragOverHandler, com.google.gwt.event.dom.client.DragStartHandler, com.google.gwt.event.dom.client.DropHandler, com.google.gwt.event.shared.EventHandler, AbstractCustomHandler

Direct Known Subclasses:

UiWidgetAdapterGwtTableColumn.ReorderHandler

public abstract class AbstractDragAndDropHandler
extends Object
implements com.google.gwt.event.dom.client.DragStartHandler, com.google.gwt.event.dom.client.DragEndHandler, com.google.gwt.event.dom.client.DropHandler, com.google.gwt.event.dom.client.DragOverHandler, AbstractCustomHandler

This is the abstract base class for an HTML5 drag and drop handler.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private com.google.gwt.user.client.ui.Widget	widget

Constructor Summary

Constructors

Constructor and Description
AbstractDragAndDropHandler() The constructor.

Method Summary

Modifier and Type	Method and Description
protected com.google.gwt.user.client.ui.Widget	getWidget()
protected boolean	isActive() This method can be overridden for dynamic activation of this handler.
void	onDragOver(com.google.gwt.event.dom.client.DragOverEvent event) ATTENTION: This method is invoked on the listener registered on the widget that is currently under the dragged item and NOT on the widget that is actually dragged around.
void	onDragStart(com.google.gwt.event.dom.client.DragStartEvent event)
void	onDrop(com.google.gwt.event.dom.client.DropEvent event)
void	register(com.google.gwt.user.client.ui.Widget dragWidget, 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

Methods inherited from interface com.google.gwt.event.dom.client.DragEndHandler

onDragEnd

Field Detail

widget

private com.google.gwt.user.client.ui.Widget widget

See Also:

getWidget()

Constructor Detail

AbstractDragAndDropHandler

public AbstractDragAndDropHandler()

The constructor.

Method Detail

getWidget

protected com.google.gwt.user.client.ui.Widget getWidget()

Returns:

the widget

register

public void register(com.google.gwt.user.client.ui.Widget dragWidget,
                     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:

dragWidget - 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.

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).

onDragStart

public void onDragStart(com.google.gwt.event.dom.client.DragStartEvent event)

Specified by:

onDragStart in interface com.google.gwt.event.dom.client.DragStartHandler

onDragOver

public void onDragOver(com.google.gwt.event.dom.client.DragOverEvent event)

ATTENTION:
This method is invoked on the listener registered on the widget that is currently under the dragged item and NOT on the widget that is actually dragged around.

Specified by:

onDragOver in interface com.google.gwt.event.dom.client.DragOverHandler

onDrop

public void onDrop(com.google.gwt.event.dom.client.DropEvent event)

Specified by:

onDrop in interface com.google.gwt.event.dom.client.DropHandler