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

java.lang.Object
  extended by com.google.gwt.event.shared.GwtEvent<H>
      extended by com.smartgwt.client.event.AbstractSmartEvent<H>
          extended by com.smartgwt.client.widgets.events.BrowserEvent<FolderClickHandler>
              extended by com.smartgwt.client.widgets.tree.events.FolderClickEvent

public class FolderClickEvent
extends BrowserEvent<FolderClickHandler>


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
FolderClickEvent(JavaScriptObject jsObj)
           
 
Method Summary
protected  void dispatch(FolderClickHandler handler)
          Should only be called by HandlerManager.
static
<S extends HasFolderClickHandlers & 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<FolderClickHandler> getAssociatedType()
          Returns the type used to register this event.
 TreeNode getFolder()
          The folder (record) that was clicked
 int getRecordNum()
          Index of the row where the click occurred.
static GwtEvent.Type<FolderClickHandler> getType()
          Gets the type associated with this event.
 TreeGrid getViewer()
          The TreeGrid on which folderClick() occurred.
 
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

FolderClickEvent

public FolderClickEvent(JavaScriptObject jsObj)
Method Detail

fire

public static <S extends HasFolderClickHandlers & 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<FolderClickHandler> getType()
Gets the type associated with this event.

Returns:
returns the handler type

dispatch

protected void dispatch(FolderClickHandler handler)
Description copied from class: GwtEvent
Should only be called by HandlerManager. In other words, do not use or call.

Specified by:
dispatch in class GwtEvent<FolderClickHandler>
Parameters:
handler - handler

getAssociatedType

public final GwtEvent.Type<FolderClickHandler> getAssociatedType()
Description copied from class: GwtEvent
Returns the type used to register this event. Used by handler manager to dispatch events to the correct handlers.

Specified by:
getAssociatedType in class GwtEvent<FolderClickHandler>
Returns:
the type

getViewer

public TreeGrid getViewer()
The TreeGrid on which folderClick() occurred.

Returns:
The TreeGrid on which folderClick() occurred.

getFolder

public TreeNode getFolder()
The folder (record) that was clicked

Returns:
The folder (record) that was clicked

getRecordNum

public int getRecordNum()
Index of the row where the click occurred.

Returns:
Index of the row where the click occurred.