org.xwiki.gwt.user.client
Class ActionEvent

java.lang.Object
  com.google.web.bindery.event.shared.Event<H>
      com.google.gwt.event.shared.GwtEvent<ActionHandler>
          org.xwiki.gwt.user.client.ActionEvent

public class ActionEvent
extends com.google.gwt.event.shared.GwtEvent<ActionHandler>

A semantic event which indicates that a component-defined action occurred.

Version:

$Id: b67540adaa4563092bd91b838a1e6fd23ffda49c $

Nested Class Summary

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

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

Constructor Summary

protected

ActionEvent(String actionName) Creates a new event for the specified action.

Method Summary

protected void	dispatch(ActionHandler handler)
static ActionEvent	fire(HasActionHandlers source, String actionName) Fires an action event on all registered handlers in the handler manager.
String	getActionName()
com.google.gwt.event.shared.GwtEvent.Type<ActionHandler>	getAssociatedType()
static com.google.gwt.event.shared.GwtEvent.Type<ActionHandler>	getType(String actionName)

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 Detail

ActionEvent

protected ActionEvent(String actionName)

Creates a new event for the specified action.

Parameters:

actionName - the name of the action that triggers this event

Method Detail

getType

public static com.google.gwt.event.shared.GwtEvent.Type<ActionHandler> getType(String actionName)

Parameters:

actionName - the name of an action

Returns:

the event type associated with the specified action

fire

public static ActionEvent fire(HasActionHandlers source,
                               String actionName)

Fires an action event on all registered handlers in the handler manager. If no such handlers exist, this method will do nothing.

Parameters:

source - the source of the handlers

actionName - the name of the action that occurred

Returns:

the fired event, or null if no handlers of the implied event type have been registered

dispatch

protected void dispatch(ActionHandler handler)

Specified by:

dispatch in class com.google.gwt.event.shared.GwtEvent<ActionHandler>

getAssociatedType

public com.google.gwt.event.shared.GwtEvent.Type<ActionHandler> getAssociatedType()

Overrides:

getAssociatedType in class com.google.gwt.event.shared.GwtEvent<ActionHandler>

getActionName

public String getActionName()

Returns:

the name of the action that triggered this event