com.sage.swt.client.widget.event
Class SwtPortletHelpClickEvent

java.lang.Object
  com.sage.swt.client.widget.event.AbstractSwtEvent
      com.sage.swt.client.widget.event.SwtPortletHelpClickEvent

All Implemented Interfaces:

com.google.gwt.event.dom.client.ClickHandler, com.google.gwt.event.shared.EventHandler, SwtEvent

public final class SwtPortletHelpClickEvent
extends AbstractSwtEvent
implements com.google.gwt.event.dom.client.ClickHandler

Class for triggering actions that are linked to click events of the Portlet window's help button.

Constructor Summary

SwtPortletHelpClickEvent(HasPortletWindowHandlers source)
Default constructor.

Method Summary

SwtEventEditor	getEditor() Gets the editor for this event.
java.util.Collection<FunctionParameter>	getFunctionParameters() Gets a FunctionParameter collection where each item describes a parameter that will be passed to the action that is called when this event is fired.
FunctionReturn	getFunctionReturn() Gets information about the return value of the action that is called when this event is fired.
void	onClick(com.google.gwt.event.dom.client.ClickEvent event)

Methods inherited from class com.sage.swt.client.widget.event.AbstractSwtEvent

addAction, executeActions, getActions, getDefaultFunctionParameters, getDefaultParams, getDesignerTooltip, getEventInfo, removeAction

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SwtPortletHelpClickEvent

public SwtPortletHelpClickEvent(HasPortletWindowHandlers source)

Default constructor.

Parameters:

source - A widget that sources the events defined by the ClickHandler interface.

Method Detail

onClick

public void onClick(com.google.gwt.event.dom.client.ClickEvent event)

Specified by:

onClick in interface com.google.gwt.event.dom.client.ClickHandler

getFunctionParameters

public java.util.Collection<FunctionParameter> getFunctionParameters()

Gets a FunctionParameter collection where each item describes a parameter that will be passed to the action that is called when this event is fired. Those parameters are passed in the order they are listed.

Specified by:

getFunctionParameters in class AbstractSwtEvent

Returns:

A FunctionParameter collection where each item describes a parameter that will be passed to the action that is called when this event is fired. Implementors should make sure that this collection is unmodifiable.

getFunctionReturn

public FunctionReturn getFunctionReturn()

Gets information about the return value of the action that is called when this event is fired. Implementors must return null if there is no return value from that action.

Specified by:

getFunctionReturn in class AbstractSwtEvent

Returns:

The information about the return value of the action that is called when this event is fired.

getEditor

public SwtEventEditor getEditor()

Gets the editor for this event. The event editor is used by the UI designer to allow a widget's events to be set without needing to recompile the UI.

Specified by:

getEditor in interface SwtEvent

Returns:

The editor for this event.