public class CmsEventManager extends java.lang.Object
OpenCms.getEventManager()
.
Events can be used in OpenCms to notify custom event listeners that certain system events have happened.
Event listeners have to implement the interface I_CmsEventListener
.
CmsEvent
,
I_CmsEventListener
Modifier and Type | Field and Description |
---|---|
protected static I_CmsEventListener[] |
EVENT_LIST
Required as template for event list generation.
|
Constructor and Description |
---|
CmsEventManager()
Create a new instance of an OpenCms event manager.
|
Modifier and Type | Method and Description |
---|---|
void |
addCmsEventListener(I_CmsEventListener listener)
Add an OpenCms event listener that listens to all events.
|
void |
addCmsEventListener(I_CmsEventListener listener,
int[] eventTypes)
Add an OpenCms event listener.
|
void |
fireEvent(CmsEvent event)
Notify all event listeners that a particular event has occurred.
|
void |
fireEvent(int type)
Notify all event listeners that a particular event has occurred without any additional event data.
|
void |
fireEvent(int type,
java.util.Map<java.lang.String,java.lang.Object> data)
Notify all event listeners that a particular event has occurred.
|
protected void |
fireEventHandler(java.util.List<I_CmsEventListener> listeners,
CmsEvent event)
Fires the specified event to a list of event listeners.
|
protected java.util.Map<java.lang.Integer,java.util.List<I_CmsEventListener>> |
getEventListeners()
Returns the map of all configured event listeners.
|
protected void |
initialize(CmsEventManager base)
Initialize this event manager with all events from the given base event manager.
|
void |
removeCmsEventListener(I_CmsEventListener listener)
Removes a cms event listener.
|
protected static final I_CmsEventListener[] EVENT_LIST
public CmsEventManager()
public void addCmsEventListener(I_CmsEventListener listener)
listener
- the listener to addpublic void addCmsEventListener(I_CmsEventListener listener, int[] eventTypes)
listener
- the listener to addeventTypes
- the events to listen forpublic void fireEvent(CmsEvent event)
event
- the event that is forwarded to all listenerspublic void fireEvent(int type)
type
- event typepublic void fireEvent(int type, java.util.Map<java.lang.String,java.lang.Object> data)
type
- event typedata
- event dataprotected void fireEventHandler(java.util.List<I_CmsEventListener> listeners, CmsEvent event)
listeners
- the listeners to fireevent
- the event to fireprotected java.util.Map<java.lang.Integer,java.util.List<I_CmsEventListener>> getEventListeners()
protected void initialize(CmsEventManager base)
base
- the base event manager to initialize this event manager withpublic void removeCmsEventListener(I_CmsEventListener listener)
listener
- the listener to remove