sky.monome.event.frame
Interface DynamicFrame<F extends DynamicFrame<F>>

Type Parameters:
F - Type of dynamic frame that implements this interface.
All Known Implementing Classes:
AbstractFrameWindow, AbstractInertiaFrameWindow, AbstractWindow, BoundedFrameWindow, CharacterFrame, FrameWindow, InertiaBoundedFrameWindow, InertiaFrameWindow, InertiaMirroredFrameWindow, MirroredFrameWindow

public interface DynamicFrame<F extends DynamicFrame<F>>

Frame that is dynamic in time. A dynamic frame can have registered listeners to listen to frame events (when frame needs to be refreshed on the physical Monome device).

Author:
PJ Skyman

Method Summary
 void addFrameListener(FrameListener<F> frameListener)
          Adds the specified frame listener to the list of frame listeners.
 void fireFrameChanged(F dynamicFrame)
          Invoked when a frame change occurs.
 FrameListener<F>[] getFrameListeners()
          Returns an array of all frame listeners.
 void removeFrameListener(FrameListener<F> frameListener)
          Removes the specified frame listener from the list of frame listeners.
 

Method Detail

addFrameListener

void addFrameListener(FrameListener<F> frameListener)
Adds the specified frame listener to the list of frame listeners.

Parameters:
frameListener - Frame listener to add to the list of frame listeners.

removeFrameListener

void removeFrameListener(FrameListener<F> frameListener)
Removes the specified frame listener from the list of frame listeners.

Parameters:
frameListener - Frame listener to remove from the list of frame listeners.

getFrameListeners

FrameListener<F>[] getFrameListeners()
Returns an array of all frame listeners.

Returns:
An array of all frame listeners.

fireFrameChanged

void fireFrameChanged(F dynamicFrame)
Invoked when a frame change occurs.

Parameters:
dynamicFrame - Dynamic frame that triggered the frame event.