com.smartgwt.client.widgets.menu.events
Class MenuItemClickEvent

java.lang.Object
  extended by com.google.gwt.event.shared.GwtEvent<H>
      extended by com.smartgwt.client.event.AbstractSmartEvent<ClickHandler>
          extended by com.smartgwt.client.widgets.menu.events.MenuItemClickEvent

public class MenuItemClickEvent
extends AbstractSmartEvent<ClickHandler>


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
MenuItemClickEvent(JavaScriptObject jsObj)
           
 
Method Summary
protected  void dispatch(ClickHandler handler)
          Should only be called by HandlerManager.
static
<S extends HasClickHandlers & 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<ClickHandler> getAssociatedType()
          Returns the type used to register this event.
 int getColNum()
          Index of the column the user clicked.
 MenuItem getItem()
          The ${isc.DocUtils.linkForRef('object:MenuItem')} that was clicked on.
 Menu getMenu()
          The ${isc.DocUtils.linkForRef('class:Menu')} instance of which this ${isc.DocUtils.linkForRef('object:MenuItem')} is a member.
 Canvas getTarget()
          for a menu shown as a context menu, the Canvas the menu was shown on.
static GwtEvent.Type<ClickHandler> getType()
          Gets the type associated with this event.
 
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

MenuItemClickEvent

public MenuItemClickEvent(JavaScriptObject jsObj)
Method Detail

fire

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

Returns:
returns the handler type

dispatch

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

getAssociatedType

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

getTarget

public Canvas getTarget()
for a menu shown as a context menu, the Canvas the menu was shown on. Otherwise the ${isc.DocUtils.linkForRef('class:Menu')} instance of which this ${isc.DocUtils.linkForRef('object:MenuItem')} is a member.

Returns:
for a menu shown as a context menu, the Canvas the menu was shown on. Otherwise the ${isc.DocUtils.linkForRef('class:Menu')} instance of which this ${isc.DocUtils.linkForRef('object:MenuItem')} is a member.

getItem

public MenuItem getItem()
The ${isc.DocUtils.linkForRef('object:MenuItem')} that was clicked on.

Returns:
The ${isc.DocUtils.linkForRef('object:MenuItem')} that was clicked on.

getMenu

public Menu getMenu()
The ${isc.DocUtils.linkForRef('class:Menu')} instance of which this ${isc.DocUtils.linkForRef('object:MenuItem')} is a member.

Returns:
The ${isc.DocUtils.linkForRef('class:Menu')} instance of which this ${isc.DocUtils.linkForRef('object:MenuItem')} is a member.

getColNum

public int getColNum()
Index of the column the user clicked. May be null if the user activated the menu via a keyboard event.

Returns:
Index of the column the user clicked. May be null if the user activated the menu via a keyboard event.