© 2003 BEA Systems, Inc.

com.bea.netuix.servlets.controls.portlet.events
Class PortletEvent

java.lang.Object
  |
  +--com.bea.netuix.nf.events.UIEvent
        |
        +--com.bea.netuix.servlets.controls.AbstractEvent
              |
              +--com.bea.netuix.servlets.controls.portlet.events.PortletEvent
All Implemented Interfaces:
Serializable

public class PortletEvent
extends AbstractEvent

A generic PortletEvent to be used by developers to perform inter portlet communications.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.bea.netuix.servlets.controls.AbstractEvent
debug
 
Constructor Summary
PortletEvent()
           
PortletEvent(Object payload)
           
 
Method Summary
static void addGlobalListener(BackingContext backingContext, PortletEventListener listener)
          Register a listener to be interesed in this event.
static AbstractEvent.Manager getEventManager(Object sourceObject, BackingContext backingContext)
          Get a reference to the Event manager.
 Object getPayload()
           
static void removeGlobalListener(BackingContext backingContext, PortletEventListener listener)
          Unregister a listener to for this event.
 void setPayload(Object payload)
           
 String toString()
           
 
Methods inherited from class com.bea.netuix.servlets.controls.AbstractEvent
addGlobalListener, getEventManager, removeGlobalListener
 
Methods inherited from class com.bea.netuix.nf.events.UIEvent
addGlobalListener, getGlobalListeners, removeGlobalListener
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PortletEvent

public PortletEvent()

PortletEvent

public PortletEvent(Object payload)
Method Detail

getPayload

public Object getPayload()

setPayload

public void setPayload(Object payload)

getEventManager

public static AbstractEvent.Manager getEventManager(Object sourceObject,
                                                    BackingContext backingContext)
Get a reference to the Event manager.

Parameters:
sourceObject - a reference to the object firing the event
backingContext - any backing context WindowBackingContext
Returns:
a reference to this events manager.

addGlobalListener

public static void addGlobalListener(BackingContext backingContext,
                                     PortletEventListener listener)
Register a listener to be interesed in this event.

Parameters:
backingContext - any backing context.
listener - object implementing AbstractEventListener

removeGlobalListener

public static void removeGlobalListener(BackingContext backingContext,
                                        PortletEventListener listener)
Unregister a listener to for this event.

Parameters:
backingContext - any backing context.
listener - object implementing AbstractEventListener

toString

public String toString()
Overrides:
toString in class Object

© 2003 BEA Systems, Inc.

Copyright © 2003 BEA Systems, Inc. All Rights Reserved