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

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<LeafContextClickHandler>
              extended by com.smartgwt.client.widgets.tree.events.LeafContextClickEvent
All Implemented Interfaces:
Cancellable

public class LeafContextClickEvent
extends BrowserEvent<LeafContextClickHandler>
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
LeafContextClickEvent(JavaScriptObject jsObj)
           
 
Method Summary
 void cancel()
          whether to cancel the event
protected  void dispatch(LeafContextClickHandler handler)
          Should only be called by HandlerManager.
static
<S extends HasLeafContextClickHandlers & 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<LeafContextClickHandler> getAssociatedType()
          Returns the type used to register this event.
 TreeNode getLeaf()
          The leaf (record) on which the contextclick occurred.
 int getRecordNum()
          Index of the row where the contextclick occurred.
static GwtEvent.Type<LeafContextClickHandler> getType()
          Gets the type associated with this event.
 TreeGrid getViewer()
          The TreeGrid on which the contexclick occurred.
 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

LeafContextClickEvent

public LeafContextClickEvent(JavaScriptObject jsObj)
Method Detail

fire

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

Returns:
returns the handler type

dispatch

protected void dispatch(LeafContextClickHandler 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<LeafContextClickHandler>
Parameters:
handler - handler

getAssociatedType

public final GwtEvent.Type<LeafContextClickHandler> 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<LeafContextClickHandler>
Returns:
the type

cancel

public void cancel()
whether to cancel the event

Specified by:
cancel in interface Cancellable

isCancelled

public boolean isCancelled()
Specified by:
isCancelled in interface Cancellable
Returns:
true if cancelled

getViewer

public TreeGrid getViewer()
The TreeGrid on which the contexclick occurred.

Returns:
The TreeGrid on which the contexclick occurred.

getLeaf

public TreeNode getLeaf()
The leaf (record) on which the contextclick occurred.

Returns:
The leaf (record) on which the contextclick occurred.

getRecordNum

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

Returns:
Index of the row where the contextclick occurred.