org.vectomatic.dnd

Class DropPanel

java.lang.Object

com.google.gwt.user.client.ui.UIObject

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

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.SimplePanel

org.vectomatic.dnd.DropPanel

All Implemented Interfaces:

com.google.gwt.event.dom.client.HasDragEnterHandlers, com.google.gwt.event.dom.client.HasDragLeaveHandlers, com.google.gwt.event.dom.client.HasDragOverHandlers, com.google.gwt.event.dom.client.HasDropHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.AcceptsOneWidget, com.google.gwt.user.client.ui.HasOneWidget, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, Iterable<com.google.gwt.user.client.ui.Widget>

public class DropPanel
extends com.google.gwt.user.client.ui.SimplePanel
implements com.google.gwt.event.dom.client.HasDropHandlers, com.google.gwt.event.dom.client.HasDragEnterHandlers, com.google.gwt.event.dom.client.HasDragLeaveHandlers, com.google.gwt.event.dom.client.HasDragOverHandlers

A widget which accepts file drag and drop. Note: users must add a handler for ALL four main events (dragenter, dragleave, dragover and drop) to prevent the default browser behavior from applying, otherwise dropping will result in the browser opening a new page with the dropped resource.

Author:

laaglu

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary

Fields

Modifier and Type	Field and Description
protected static com.google.gwt.event.shared.EventBus	eventBus The event bus shared by all drop panels

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
DropPanel() Constructor.

Method Summary

Modifier and Type	Method and Description
com.google.gwt.event.shared.HandlerRegistration	addDragEnterHandler(com.google.gwt.event.dom.client.DragEnterHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addDragLeaveHandler(com.google.gwt.event.dom.client.DragLeaveHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addDragOverHandler(com.google.gwt.event.dom.client.DragOverHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addDropHandler(com.google.gwt.event.dom.client.DropHandler handler)
void	dispatch(com.google.gwt.dom.client.NativeEvent event) Dispatches the specified event to this node event handlers
void	fireEvent(com.google.gwt.event.shared.GwtEvent<?> event)
static com.google.gwt.event.shared.EventBus	getEventBus() Returns the event bus shared by all drop panels
protected boolean	isChildOf(com.google.gwt.dom.client.Node root, com.google.gwt.dom.client.Node node) Tests if a node is part of a DOM subtree.
static void	setEventBus(com.google.gwt.event.shared.EventBus eventBus) Sets the event bus shared by all drop panels

Methods inherited from class com.google.gwt.user.client.ui.SimplePanel

add, getContainerElement, getWidget, iterator, remove, setWidget, setWidget

Methods inherited from class com.google.gwt.user.client.ui.Panel

add, adopt, clear, doAttachChildren, doDetachChildren, orphan, remove

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

eventBus

protected static com.google.gwt.event.shared.EventBus eventBus

The event bus shared by all drop panels

Constructor Detail

DropPanel

public DropPanel()

Constructor. The size of the widget should be set using CSS.

Method Detail

getEventBus

public static com.google.gwt.event.shared.EventBus getEventBus()

Returns the event bus shared by all drop panels

Returns:

the event bus shared by all drop panels

setEventBus

public static void setEventBus(com.google.gwt.event.shared.EventBus eventBus)

Sets the event bus shared by all drop panels

Parameters:

eventBus - the event bus shared by all drop panels

fireEvent

public void fireEvent(com.google.gwt.event.shared.GwtEvent<?> event)

Specified by:

fireEvent in interface com.google.gwt.event.shared.HasHandlers

Overrides:

fireEvent in class com.google.gwt.user.client.ui.Widget

dispatch

public void dispatch(com.google.gwt.dom.client.NativeEvent event)

Dispatches the specified event to this node event handlers

Parameters:

event - The event to dispatch

isChildOf

protected boolean isChildOf(com.google.gwt.dom.client.Node root,
                            com.google.gwt.dom.client.Node node)

Tests if a node is part of a DOM subtree.

Parameters:

root - The subtree root

node - The node to be tested

Returns:

True if the node is part of the subtree, false otherwise

addDropHandler

public com.google.gwt.event.shared.HandlerRegistration addDropHandler(com.google.gwt.event.dom.client.DropHandler handler)

Specified by:

addDropHandler in interface com.google.gwt.event.dom.client.HasDropHandlers

addDragLeaveHandler

public com.google.gwt.event.shared.HandlerRegistration addDragLeaveHandler(com.google.gwt.event.dom.client.DragLeaveHandler handler)

Specified by:

addDragLeaveHandler in interface com.google.gwt.event.dom.client.HasDragLeaveHandlers

addDragEnterHandler

public com.google.gwt.event.shared.HandlerRegistration addDragEnterHandler(com.google.gwt.event.dom.client.DragEnterHandler handler)

Specified by:

addDragEnterHandler in interface com.google.gwt.event.dom.client.HasDragEnterHandlers

addDragOverHandler

public com.google.gwt.event.shared.HandlerRegistration addDragOverHandler(com.google.gwt.event.dom.client.DragOverHandler handler)

Specified by:

addDragOverHandler in interface com.google.gwt.event.dom.client.HasDragOverHandlers