Favorites.FavoriteSelectionEvent (adams-pom 24.5.0-SNAPSHOT API)

java.lang.Object
- java.util.EventObject
- - adams.gui.goe.Favorites.FavoriteSelectionEvent

All Implemented Interfaces:

Serializable

Enclosing class:

Favorites
```
public static class Favorites.FavoriteSelectionEvent
extends EventObject
```
Event that gets sent when a favorite gets selected.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  protected Favorites.Favorite m_Favorite
  the selected favorite.
  - Fields inherited from class java.util.EventObject
    source
- Constructor Summary
  
  Constructors
  Constructor Description
  
  FavoriteSelectionEvent(Object source, Favorites.Favorite favorite)
  Initializes the event.
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  Favorites.Favorite getFavorite()
  Returns the selected favorite.
  - 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_Favorite
```
protected Favorites.Favorite m_Favorite
```
    the selected favorite.
- Constructor Detail
  - FavoriteSelectionEvent
```
public FavoriteSelectionEvent(Object source,
                              Favorites.Favorite favorite)
```
    Initializes the event.
    
    Parameters:
    
    source - the object that triggered the event
    
    favorite - the selected favorite
- Method Detail
  - getFavorite
```
public Favorites.Favorite getFavorite()
```
    Returns the selected favorite.
    
    Returns:
    
    the favorite