AnnotationEvent (adams-addons-pom 24.11.0-SNAPSHOT API)

java.lang.Object
- java.util.EventObject
- - adams.gui.tools.audioannotator.AnnotationEvent

All Implemented Interfaces:

Serializable
```
public class AnnotationEvent
extends EventObject
```
An action that is raised when an annotation is required

Author:

sjb90

See Also:

Serialized Form

- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  protected AudioAnnotation m_Annotation
  The annotation we're passing to the listeners
  - Fields inherited from class java.util.EventObject
    source
- Constructor Summary
  
  Constructors
  Constructor Description
  
  AnnotationEvent(Object source, AudioAnnotation annotation)
  Constructs an Annotation Event
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  AudioAnnotation getAnnotation()
  A getter for the annotation this event is for
  - Methods inherited from class java.util.EventObject
    getSource, toString
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - m_Annotation
```
protected AudioAnnotation m_Annotation
```
    The annotation we're passing to the listeners
- Constructor Detail
  - AnnotationEvent
```
public AnnotationEvent(Object source,
                       AudioAnnotation annotation)
```
    Constructs an Annotation Event
    
    Parameters:
    
    source - The object on which the Event initially occurred.
    
    annotation - The annotation object the listener will make use of
    
    Throws:
    
    IllegalArgumentException - if source is null or if annotation is null
- Method Detail
  - getAnnotation
```
public AudioAnnotation getAnnotation()
```
    A getter for the annotation this event is for
    
    Returns:
    
    the step associated with this event