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

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

public class OpenURLEvent
extends com.google.gwt.event.shared.GwtEvent<OpenURLHandler>

Fired when a URL portlet needs to be opened.

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	OpenURLEvent(java.lang.String caption, java.lang.String url) Construct a new OpenURLEvent.
protected	OpenURLEvent(java.lang.String caption, java.lang.String url, java.lang.String portletCommunicationID) Construct a new OpenURLEvent.
protected	OpenURLEvent(java.lang.String caption, java.lang.String url, java.lang.String portletCommunicationID, boolean dialogUI) Construct a new OpenURLEvent.

Method Summary

protected void	dispatch(OpenURLHandler handler)
static <S extends HasPortletOpenedHandlers & com.google.gwt.event.shared.HasHandlers> void	fire(S source, java.lang.String caption, java.lang.String url) Fires an open URL portlet event on all registered handlers in the handler source.
static <S extends HasPortletOpenedHandlers & com.google.gwt.event.shared.HasHandlers> void	fire(S source, java.lang.String caption, java.lang.String url, java.lang.String portletCommunicationID) Fires an open URL portlet event on all registered handlers in the handler source and specifies the portletCommunicationID for the portlet that they want this portlet to replace.
com.google.gwt.event.shared.GwtEvent.Type<OpenURLHandler>	getAssociatedType()
java.lang.String	getCaption() Gets the caption for the portlet
java.lang.String	getPortletCommunicationID() Gets the id of a portlet that is already opened in the Portal.
static com.google.gwt.event.shared.GwtEvent.Type<OpenURLHandler>	getType() Ensures the existence of the handler hook and then returns it.
java.lang.String	getURL() Gets the URL that will be opened in the portlet
boolean	isDialogUI() Returns true if this is a report or process UI that will be displayed as a "dialog" in the Portal; otherwise, returns false.

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

OpenURLEvent

protected OpenURLEvent(java.lang.String caption,
                       java.lang.String url)

Construct a new OpenURLEvent.

Parameters:

caption - The caption for the url portlet

url - The url that will be opened in the portlet

OpenURLEvent

protected OpenURLEvent(java.lang.String caption,
                       java.lang.String url,
                       java.lang.String portletCommunicationID)

Construct a new OpenURLEvent.

Parameters:

caption - The caption for the url portlet

url - The url that will be opened in the portlet

portletCommunicationID - The id of a portlet that is already opened in the Portal. When this event opens the new portlet (specified by the url parameter), it will close the portlet that corresponds to this id and replace it the new portlet.

OpenURLEvent

protected OpenURLEvent(java.lang.String caption,
                       java.lang.String url,
                       java.lang.String portletCommunicationID,
                       boolean dialogUI)

Construct a new OpenURLEvent.

Parameters:

caption - The caption for the url portlet

url - The url that will be opened in the portlet

portletCommunicationID - The id of a portlet that is already opened in the Portal. When this event opens the new portlet (specified by the url parameter), it will close the portlet that corresponds to this id and replace it the new portlet.

dialogUI - Specify true if this is a report or process UI that will be displayed as a "dialog" in the Portal; otherwise, specify false.

Method Detail

fire

public static <S extends HasPortletOpenedHandlers & com.google.gwt.event.shared.HasHandlers> void fire(S source,
                                                                                                      java.lang.String caption,
                                                                                                      java.lang.String url)

Fires an open URL portlet event on all registered handlers in the handler source.

Type Parameters:

S - The handler source

Parameters:

source - the source of the handlers

caption - The caption for the url portlet

url - The url that will be opened in the portlet

fire

public static <S extends HasPortletOpenedHandlers & com.google.gwt.event.shared.HasHandlers> void fire(S source,
                                                                                                      java.lang.String caption,
                                                                                                      java.lang.String url,
                                                                                                      java.lang.String portletCommunicationID)

Fires an open URL portlet event on all registered handlers in the handler source and specifies the portletCommunicationID for the portlet that they want this portlet to replace.

Type Parameters:

S - The handler source

Parameters:

source - the source of the handlers

caption - The caption for the url portlet

url - The url that will be opened in the portlet

portletCommunicationID - The id of a portlet that is already opened in the Portal. When this event opens the new portlet (specified by the url parameter), it will close the portlet that corresponds to this id and replace it the new portlet.

getType

public static com.google.gwt.event.shared.GwtEvent.Type<OpenURLHandler> 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<OpenURLHandler> getAssociatedType()

Overrides:

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

getCaption

public java.lang.String getCaption()

Gets the caption for the portlet

Returns:

the caption for the portlet

getURL

public java.lang.String getURL()

Gets the URL that will be opened in the portlet

Returns:

the URL that will be opened in the portlet

getPortletCommunicationID

public java.lang.String getPortletCommunicationID()

Gets the id of a portlet that is already opened in the Portal. When this event opens the new portlet (specified by the url parameter), it will close the portlet that corresponds to this id and replace it the new portlet.

Returns:

The id of a portlet that is already opened in the Portal. When this event opens the new portlet (specified by the url parameter), it will close the portlet that corresponds to this id and replace it the new portlet.

isDialogUI

public boolean isDialogUI()

Returns true if this is a report or process UI that will be displayed as a "dialog" in the Portal; otherwise, returns false.

Returns:

true if this is a report or process UI that will be displayed as a "dialog" in the Portal; otherwise, returns false.

dispatch

protected void dispatch(OpenURLHandler handler)

Specified by:

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