com.sage.swt.client.portal.communication
Class PortletClosingEvent

java.lang.Object
  com.google.web.bindery.event.shared.Event<H>
      com.google.gwt.event.shared.GwtEvent<PortletClosingHandler>
          com.sage.swt.client.portal.communication.PortletClosingEvent

public class PortletClosingEvent
extends com.google.gwt.event.shared.GwtEvent<PortletClosingHandler>

Event that is fired when the portlet is being closed.

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

PortletClosingEvent() Construct a new PortletClosingEvent.

Method Summary

protected void	dispatch(PortletClosingHandler handler)
static <S extends HasPortletClosingHandlers & com.google.gwt.event.shared.HasHandlers> PortletClosingEvent	fire(S source) Fires a portlet closing event on all registered handlers in the handler source.
com.google.gwt.event.shared.GwtEvent.Type<PortletClosingHandler>	getAssociatedType()
java.lang.String	getMessage() Returns the message to be displayed in the close confirmation dialog box.
static com.google.gwt.event.shared.GwtEvent.Type<PortletClosingHandler>	getType() Ensures the existence of the handler hook and then returns it.
void	setMessage(java.lang.String message) Sets the message to be displayed in the close confirmation dialog box, if any.

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

PortletClosingEvent

protected PortletClosingEvent()

Construct a new PortletClosingEvent.

Method Detail

fire

public static <S extends HasPortletClosingHandlers & com.google.gwt.event.shared.HasHandlers> PortletClosingEvent fire(S source)

Fires a portlet closing event on all registered handlers in the handler source.

Type Parameters:

S - The handler source

Parameters:

source - the source of the handlers

Returns:

PortletClosingEvent

getType

public static com.google.gwt.event.shared.GwtEvent.Type<PortletClosingHandler> getType()

Ensures the existence of the handler hook and then returns it.

Returns:

returns a handler hook

getAssociatedType

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

Overrides:

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

setMessage

public void setMessage(java.lang.String message)

Sets the message to be displayed in the close confirmation dialog box, if any. If multiple handlers return messages, only the last one will be displayed. All others will be ignored.

Parameters:

message - the message

getMessage

public java.lang.String getMessage()

Returns the message to be displayed in the close confirmation dialog box. Can be null

Returns:

the message to be displayed in the close confirmation dialog box. Can be null

dispatch

protected void dispatch(PortletClosingHandler handler)

Specified by:

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