PortletEvent Class

DEPRECATED As of 8.1 SP4, replaced by com.bea.netuix.events.CustomEvent

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

public class PortletEvent

    extends AbstractEvent

A generic event class to be used by developers to perform interportlet communications. You can attach an arbitrary payload to this object.

To fire a portlet event, get the event manager using the static method getEventManager and call fireEvent on it.

Hierarchy
Object
  UIEvent
    AbstractEvent
      PortletEvent
All Implemented Interfaces

Serializable

Nested Class Summary
 
Nested classes from  com.bea.netuix.servlets.controls.AbstractEvent
AbstractEvent.Manager
 

Field Summary
   
Fields from  com.bea.netuix.servlets.controls.AbstractEvent
debug
 

Constructor Summary
PortletEvent()
PortletEvent(Object payload)

Set the payload.
 

Method Summary
public static void
addGlobalListener(BackingContext backingContext, PortletEventListener listener)
Register a listener to be interested PortletEvent events.
public static AbstractEvent.Manager
getEventManager(Object sourceObject, BackingContext backingContext)
Get a reference to the Event manager.
public Object
getPayload()
public static void
removeGlobalListener(BackingContext backingContext, PortletEventListener listener)
Unregister a listener for PortletEvent events.
public void
setPayload(Object payload)
Set the event payload.
public String
toString()
 
Methods from  com.bea.netuix.servlets.controls.AbstractEvent
addGlobalListener, getEventManager, removeGlobalListener
 
Methods from  com.bea.netuix.nf.events.UIEvent
addGlobalListener, getGlobalListeners, removeGlobalListener
 
Methods 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)
Set the payload. The payload is arbitrary and opaque to the portal framework. Listeners will have to know what to do with the payload.
 

Method Detail

addGlobalListener(BackingContext, PortletEventListener) Method

public static void addGlobalListener(BackingContext backingContext, 
                                     PortletEventListener listener)
Register a listener to be interested PortletEvent events. When such an event is fired, all listeners will have their handleEvent methods called.

Parameters

backingContext
any backing context.
listener
object implementing AbstractEventListener

getEventManager(Object, BackingContext) Method

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.

getPayload() Method

public Object getPayload()

removeGlobalListener(BackingContext, PortletEventListener) Method

public static void removeGlobalListener(BackingContext backingContext, 
                                        PortletEventListener listener)
Unregister a listener for PortletEvent events.

Parameters

backingContext
any backing context.
listener
object implementing AbstractEventListener

setPayload(Object) Method

public void setPayload(Object payload)
Set the event payload. This payload is used by the consumer of the event only.

toString() Method

public String toString()
Overrides
Object.toString()