-
- All Implemented Interfaces:
-
com.brightcove.player.event.Component
public abstract class AbstractComponent implements Component
Provides some common implementation that useful to all that interact with RegisteringEventEmitters components, including:
- Maintaining a reference to an EventEmitter
- Wraps incoming EventEmitter in a RegisteringEventEmitter
- Ensures incoming EventEmitter is not null
- Maintains a collection of EventListener tokens for use with EventEmitter.off()
- Provides standard required method for initializing Event listeners
-
-
Field Summary
Fields Modifier and Type Field Description protected EventEmitter
eventEmitter
-
Constructor Summary
Constructors Constructor Description AbstractComponent(EventEmitter eventEmitter, Class<out Component> componentClass)
Being Components, Controllers inheriting from AbstractController require an EventEmitter oninitialization. AbstractComponent(EventEmitter eventEmitter)
Build an AbstractComponent that does not use a registering event emitter.
-
Method Summary
Modifier and Type Method Description EventEmitter
getEventEmitter()
Provides a reference to the EventEmitter with which this component was initialized void
addListener(String eventType, EventListener listener)
Convenience method to add an EventListener for the given type using the EventEmitter.on()method. void
addOnceListener(String eventType, EventListener listener)
Convenience method to add an EventListener for the given type using the EventEmitter.once()method. void
removeListener(String eventType)
Removes the specified listener from the EventEmitter. void
removeListeners()
Removes all set listeners from the EventEmitter. -
-
Constructor Detail
-
AbstractComponent
AbstractComponent(EventEmitter eventEmitter, Class<out Component> componentClass)
Being Components, Controllers inheriting from AbstractController require an EventEmitter oninitialization.- Parameters:
eventEmitter
- the EventEmitter through which this Component will listen for and emitevents to interact with other components in the player
-
AbstractComponent
AbstractComponent(EventEmitter eventEmitter)
Build an AbstractComponent that does not use a registering event emitter.- Parameters:
eventEmitter
- the EventEmitter through which this Component will listen for and emitevents to interact with other components in the player
-
-
Method Detail
-
getEventEmitter
EventEmitter getEventEmitter()
Provides a reference to the EventEmitter with which this component was initialized
-
addListener
void addListener(String eventType, EventListener listener)
Convenience method to add an EventListener for the given type using the EventEmitter.on()method.
- Parameters:
eventType
- the EventType for which the listener should be calledlistener
- the implementation of EventListener for this EventType
-
addOnceListener
void addOnceListener(String eventType, EventListener listener)
Convenience method to add an EventListener for the given type using the EventEmitter.once()method.
- Parameters:
eventType
- the EventType for which the listener should be calledlistener
- the implementation of EventListener for this EventType
-
removeListener
void removeListener(String eventType)
Removes the specified listener from the EventEmitter.
- Parameters:
eventType
- the EventType for which the listener should be called
-
removeListeners
void removeListeners()
Removes all set listeners from the EventEmitter.
-
-
-
-