com.sage.swt.client.portal.communication
Interface Portlet

All Superinterfaces:

com.google.gwt.event.shared.HasHandlers, HasPortletClosedHandlers, HasPortletClosingHandlers

All Known Implementing Classes:

AbstractSwtPortletWidget, SwtLayoutPortlet, SwtPrintProcessTab, SwtUrlPortlet

public interface Portlet
extends HasPortletClosedHandlers, HasPortletClosingHandlers

The interface implemented by portlet widgets.

Field Summary

static java.lang.String	PORTLET_ID_SEPARATOR
static java.lang.String	PORTLET_IPCID_URL_PARAM
static java.lang.String	PORTLET_OBJECTID_URL_PARAM

Method Summary

com.google.gwt.event.shared.HandlerRegistration	addPortletClosedHandler(PortletClosedHandler handler) Adds a PortletClosedEvent handler.
com.google.gwt.event.shared.HandlerRegistration	addPortletClosingHandler(PortletClosingHandler handler) Adds a PortletClosingEvent handler.
void	destroy() Destroys a portlet, cleaning up resources that are being held (such as the URL contents that a portlet may have loaded).
java.lang.String	getPortletCommunicationID() Returns a unique ID for the portlet that will be used for inter-portlet communications.
java.lang.String	getPortletID() Returns the ID for the portlet.
void	init() Initializes a portlet.
void	notifyAction(java.lang.String nameSpace, java.lang.String topicID, java.lang.String action, java.lang.String portletCommunicationID, java.lang.String data) Sends a notification that an IPC event occurred.

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Field Detail

PORTLET_IPCID_URL_PARAM

static final java.lang.String PORTLET_IPCID_URL_PARAM

See Also:

Constant Field Values

PORTLET_OBJECTID_URL_PARAM

static final java.lang.String PORTLET_OBJECTID_URL_PARAM

See Also:

Constant Field Values

PORTLET_ID_SEPARATOR

static final java.lang.String PORTLET_ID_SEPARATOR

See Also:

Constant Field Values

Method Detail

getPortletCommunicationID

java.lang.String getPortletCommunicationID()

Returns a unique ID for the portlet that will be used for inter-portlet communications.

Returns:

A unique ID for the portlet that will be used for inter-portlet communications.

getPortletID

java.lang.String getPortletID()

Returns the ID for the portlet.

Returns:

The ID for the portlet.

notifyAction

void notifyAction(java.lang.String nameSpace,
                  java.lang.String topicID,
                  java.lang.String action,
                  java.lang.String portletCommunicationID,
                  java.lang.String data)

Sends a notification that an IPC event occurred.

Parameters:

nameSpace - The namespace of the event.

topicID - The topic of the event.

action - The event's action.

portletCommunicationID - The communication ID of the portlet doing the publishing (where that ID is the portlet communication ID of its instance context).

data - The data associated with that action.

addPortletClosedHandler

com.google.gwt.event.shared.HandlerRegistration addPortletClosedHandler(PortletClosedHandler handler)

Adds a PortletClosedEvent handler.

Specified by:

addPortletClosedHandler in interface HasPortletClosedHandlers

Parameters:

handler - the handler

Returns:

the handler registration

addPortletClosingHandler

com.google.gwt.event.shared.HandlerRegistration addPortletClosingHandler(PortletClosingHandler handler)

Adds a PortletClosingEvent handler.

Specified by:

addPortletClosingHandler in interface HasPortletClosingHandlers

Parameters:

handler - the handler

Returns:

the handler registration

init

void init()

Initializes a portlet.

destroy

void destroy()

Destroys a portlet, cleaning up resources that are being held (such as the URL contents that a portlet may have loaded). The portlet should not be used after this call.