com.smartgwt.client.widgets.tree.events
Class FolderDropEvent

java.lang.Object
  com.google.gwt.event.shared.GwtEvent<H>
      com.smartgwt.client.event.AbstractSmartEvent<H>
          com.smartgwt.client.widgets.events.BrowserEvent<FolderDropHandler>
              com.smartgwt.client.widgets.tree.events.FolderDropEvent

All Implemented Interfaces:

Cancellable

public class FolderDropEvent
extends BrowserEvent<FolderDropHandler>
implements Cancellable

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.event.shared.GwtEvent

GwtEvent.Type<H>

Field Summary

Fields inherited from class com.smartgwt.client.event.AbstractSmartEvent

jsObj

Constructor Summary

FolderDropEvent(JavaScriptObject jsObj)

Method Summary

void	cancel() Call this method to cancel standard folder drop processing
protected void	dispatch(FolderDropHandler handler)
static <S extends HasFolderDropHandlers & HasHandlers> void	fire(S source, JavaScriptObject jsObj) Fires a open event on all registered handlers in the handler manager.If no such handlers exist, this method will do nothing.
GwtEvent.Type<FolderDropHandler>	getAssociatedType()
TreeNode	getFolder() The folder being dropped on
Integer	getIndex() Within the folder being dropped on, the index at which the drop is occurring.
TreeNode[]	getNodes() List of nodes being dropped
Canvas	getSourceWidget() The component that is the source of the nodes (where the nodes were dragged from).
static GwtEvent.Type<FolderDropHandler>	getType() Gets the type associated with this event.
boolean	isCancelled()

Methods inherited from class com.smartgwt.client.widgets.events.BrowserEvent

getX, getY, isAltKeyDown, isCtrlKeyDown, isLeftButtonDown, isRightButtonDown

Methods inherited from class com.google.gwt.event.shared.GwtEvent

assertLive, getSource, isLive, kill, revive, toDebugString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FolderDropEvent

public FolderDropEvent(JavaScriptObject jsObj)

Method Detail

fire

public static <S extends HasFolderDropHandlers & HasHandlers> void fire(S source,
                                                                       JavaScriptObject jsObj)

Fires a open event on all registered handlers in the handler manager.If no such handlers exist, this method will do nothing.

Type Parameters:

S - The event source

Parameters:

source - the source of the handlers

jsObj - the native event

getType

public static GwtEvent.Type<FolderDropHandler> getType()

Gets the type associated with this event.

Returns:

returns the handler type

dispatch

protected void dispatch(FolderDropHandler handler)

Specified by:

dispatch in class GwtEvent<FolderDropHandler>

getAssociatedType

public final GwtEvent.Type<FolderDropHandler> getAssociatedType()

Specified by:

getAssociatedType in class GwtEvent<FolderDropHandler>

cancel

public void cancel()

Call this method to cancel standard folder drop processing

Specified by:

cancel in interface Cancellable

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Cancellable

Returns:

true if cancelled

getNodes

public TreeNode[] getNodes()

List of nodes being dropped

Returns:

List of nodes being dropped

getFolder

public TreeNode getFolder()

The folder being dropped on

Returns:

The folder being dropped on

getIndex

public Integer getIndex()

Within the folder being dropped on, the index at which the drop is occurring. Returns null if canReorderRecords is false.

Returns:

Within the folder being dropped on, the index at which the drop is occurring.

getSourceWidget

public Canvas getSourceWidget()

The component that is the source of the nodes (where the nodes were dragged from).

Returns:

The component that is the source of the nodes (where the nodes were dragged from).