Package com.smartgwt.client.widgets.tree.events

Class FolderOpenedEvent

java.lang.Object

com.google.web.bindery.event.shared.Event<H>

com.google.gwt.event.shared.GwtEvent<H>

com.smartgwt.client.event.AbstractSmartEvent<H>

com.smartgwt.client.widgets.events.BrowserEvent<FolderOpenedHandler>

com.smartgwt.client.widgets.tree.events.FolderOpenedEvent

All Implemented Interfaces:

Cancellable

public class FolderOpenedEvent
extends BrowserEvent<FolderOpenedHandler>
implements Cancellable

Nested Class Summary

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

GwtEvent.Type<H extends Object>

Field Summary

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

jsObj

Constructor Summary

Constructors

Constructor	Description
FolderOpenedEvent(JavaScriptObject jsObj)

Method Summary

Modifier and Type	Method	Description
void	cancel()	Call this method to cancel the open, true to all it to proceed
protected void	dispatch(FolderOpenedHandler handler)
static <S extends HasFolderOpenedHandlers & 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.
final GwtEvent.Type<FolderOpenedHandler>	getAssociatedType()
Canvas	getFiringCanvas()	Returns the Canvas firing the event.
TreeNode	getNode()	the folder (record) that is being opened
String	getPath()	optional parameter containing the full path to the node.
static GwtEvent.Type<FolderOpenedHandler>	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.smartgwt.client.event.AbstractSmartEvent

getFiringInstanceAsJavaScriptObject

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

assertLive, getSource, isLive, kill, revive

Methods inherited from class com.google.web.bindery.event.shared.Event

setSource, toDebugString, toString

Methods inherited from class java.lang.Object

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

Constructor Details

FolderOpenedEvent

public FolderOpenedEvent(JavaScriptObject jsObj)

Method Details

getFiringCanvas

public Canvas getFiringCanvas()

Returns the Canvas firing the event.

Returns:

Canvas firing the event

fire

public static <S extends HasFolderOpenedHandlers & 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<FolderOpenedHandler> getType()

Gets the type associated with this event.

Returns:

returns the handler type

dispatch

protected void dispatch(FolderOpenedHandler handler)

Specified by:

dispatch in class GwtEvent<FolderOpenedHandler>

getAssociatedType

public final GwtEvent.Type<FolderOpenedHandler> getAssociatedType()

Specified by:

getAssociatedType in class GwtEvent<FolderOpenedHandler>

cancel

public void cancel()

Call this method to cancel the open, true to all it to proceed

Specified by:

cancel in interface Cancellable

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Cancellable

Returns:

true if cancelled

getNode

public TreeNode getNode()

the folder (record) that is being opened

Returns:

the folder (record) that is being opened

getPath

public String getPath()

optional parameter containing the full path to the node. This is essential context for a multi-link tree, but is not required in ordinary trees

Returns:

optional parameter containing the full path to the node. This is essential context for a multi-link tree, but is not required in ordinary trees