| java.lang.Object | |
| ↳ | com.pnfsoftware.jeb.util.events.EventSource |
 Known Direct Subclasses
|
|
Known Indirect Subclasses
|
Class Overview
Standard implementation for an event source.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
EventSource()
Create an event source not attached to a parent source.
| |||||||||||
|
EventSource(EventSource parentSource)
Create an event source attached to an optional parent source.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| synchronized void |
addListener(IEventListener listener)
Register a listener.
| ||||||||||
| synchronized int |
countListeners()
Get the numbers of objects listening to this event source.
| ||||||||||
| synchronized List<IEventListener> |
getListeners()
Get a copy of the list of listeners.
| ||||||||||
| synchronized IEventSource |
getParentSource()
Get the parent source.
| ||||||||||
| synchronized void |
insertListener(int index, IEventListener listener)
Insert a listner at the given position.
| ||||||||||
| void | notifyListeners(Event e) | ||||||||||
| void |
notifyListeners(IEvent e)
Notify listeners that an event has occurred.
| ||||||||||
| static IEventListener |
relay(IEventSource origin, IEventSource proxy)
Relay events issued from an origin to the listeners of a proxy.
| ||||||||||
| synchronized boolean |
removeListener(IEventListener listener)
Unregister a listener.
| ||||||||||
| synchronized void |
setParentSource(IEventSource parentSource)
Set a parent source.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.lang.Object
| |||||||||||
|
From interface
com.pnfsoftware.jeb.util.events.IEventSource
| |||||||||||
Public Constructors
public EventSource ()
Create an event source not attached to a parent source.
public EventSource (EventSource parentSource)
Create an event source attached to an optional parent source. If present, events generated by this source will be propagated to its listeners as well as the parent source's listeners.
Parameters
| parentSource | optional parent source |
|---|
Public Methods
public synchronized void addListener (IEventListener listener)
Register a listener. The implementor may allow duplicates.
Parameters
| listener | a listener of events generated by this source |
|---|
public synchronized int countListeners ()
Get the numbers of objects listening to this event source.
Returns
- the number of listeners
public synchronized IEventSource getParentSource ()
Get the parent source.
Returns
- the parent source, or null if none
public synchronized void insertListener (int index, IEventListener listener)
Insert a listner at the given position.
public void notifyListeners (IEvent e)
Notify listeners that an event has occurred.
Parameters
| e | the event to be propagated |
|---|
public static IEventListener relay (IEventSource origin, IEventSource proxy)
Relay events issued from an origin to the listeners of a proxy.
Parameters
| origin | events are emitted by this origin event source |
|---|---|
| proxy | events will be relayed by this proxy event source |
Returns
- the event listener/relayer object, which should be disposed by the caller after the origin is destroyed
public synchronized boolean removeListener (IEventListener listener)
Unregister a listener. If the implementor allows duplicates in addListener(), it should deal with those consistently.
Parameters
| listener | the listener to be removed |
|---|
Returns
- true if the listener was successfully removed, false
public synchronized void setParentSource (IEventSource parentSource)
Set a parent source.
Parameters
| parentSource | the optional parent source |
|---|