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

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<ItemClickHandler>
              extended by com.smartgwt.client.widgets.menu.events.ItemClickEvent
All Implemented Interfaces:
Cancellable

public class ItemClickEvent
extends BrowserEvent<ItemClickHandler>
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
ItemClickEvent(com.google.gwt.core.client.JavaScriptObject jsObj)
           
 
Method Summary
 void cancel()
          false if event processing should be stopped, true to continue
protected  void dispatch(ItemClickHandler handler)
          Should only be called by HandlerManager.
static
<S extends HasItemClickHandlers & HasHandlers>
void
fire(S source, com.google.gwt.core.client.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<ItemClickHandler> getAssociatedType()
          Returns the type used to register this event.
 int getColNum()
          Index of the column clicked by the user.
 MenuItem getItem()
          pointer to the item in question
static GwtEvent.Type<ItemClickHandler> 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

ItemClickEvent

public ItemClickEvent(com.google.gwt.core.client.JavaScriptObject jsObj)
Method Detail

fire

public static <S extends HasItemClickHandlers & HasHandlers> void fire(S source,
                                                                      com.google.gwt.core.client.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<ItemClickHandler> getType()
Gets the type associated with this event.

Returns:
returns the handler type

dispatch

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

getAssociatedType

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

cancel

public void cancel()
false if event processing should be stopped, true to continue

Specified by:
cancel in interface Cancellable

isCancelled

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

getColNum

public int getColNum()
Index of the column clicked by the user. May be null if this menu item was activated in response to a keyboard event.

Returns:
Index of the column clicked by the user. May be null if this menu item was activated in response to a keyboard event.

getItem

public MenuItem getItem()
pointer to the item in question

Returns:
pointer to the item in question