Module io.github.tonywasher.joceanus.oceanus

Package io.github.tonywasher.joceanus.oceanus.event

Class OceanusEventRegistrar<E extends Enum<E>>

java.lang.Object

io.github.tonywasher.joceanus.oceanus.event.OceanusEventRegistrar<E>

Type Parameters:

E - The event id type

public class OceanusEventRegistrar<E extends Enum<E>>
extends Object

EventRegister implementation. This maintains a list of Action/Change/ItemListeners/ActionListeners and allows the caller to fire Action/Change/ItemEvents and ActionEvents to these listeners. This is implemented to provide functionality to non-GUI components and also to enable improved control over the contents of the ChangeEvents and ActionEvents that are fired.

This class is used by listeners to register to listen for events.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OceanusEventRegistrar.OceanusEventProvider<E extends Enum<E>>	Interface for event providers.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OceanusEventRegistrar(Integer pMgrId)	Constructor.

Method Summary

Modifier and Type	Method	Description
OceanusEventRegistration<E>	addEventListener(E pEventId, OceanusEvent.OceanusEventListener<E> pListener)	Add filtered event Listener to list.
OceanusEventRegistration<E>	addEventListener(OceanusEvent.OceanusEventListener<E> pListener)	Add event Listener to list.
protected Iterator<OceanusEventRegistration<E>>	iterator()	Obtain registration iterator.
void	removeEventListener(OceanusEventRegistration<E> pRegistration)	Remove Event Listener.
(package private) ListIterator<OceanusEventRegistration<E>>	reverseIterator()	Obtain reverse registration iterator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OceanusEventRegistrar

protected OceanusEventRegistrar(Integer pMgrId)

Constructor.

Parameters:

pMgrId - the manager id

Method Details

iterator

protected Iterator<OceanusEventRegistration<E>> iterator()

Obtain registration iterator.

Returns:

the iterator

reverseIterator

ListIterator<OceanusEventRegistration<E>> reverseIterator()

Obtain reverse registration iterator.

Returns:

the iterator

addEventListener

public OceanusEventRegistration<E> addEventListener(OceanusEvent.OceanusEventListener<E> pListener)

Add event Listener to list.

Parameters:

pListener - the listener to add

Returns:

the registration

addEventListener

public OceanusEventRegistration<E> addEventListener(E pEventId,
 OceanusEvent.OceanusEventListener<E> pListener)

Add filtered event Listener to list.

Parameters:

pEventId - the explicit event id to listen for

pListener - the listener to add

Returns:

the registration

removeEventListener

public void removeEventListener(OceanusEventRegistration<E> pRegistration)

Remove Event Listener.

Parameters:

pRegistration - the registration to remove