1   /**
2    * Distribution License:
3    * BibleDesktop is free software; you can redistribute it and/or modify it under
4    * the terms of the GNU General Public License, version 2 as published by
5    * the Free Software Foundation. This program is distributed in the hope
6    * that it will be useful, but WITHOUT ANY WARRANTY; without even the
7    * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
8    * See the GNU General Public License for more details.
9    *
10   * The License is available on the internet at:
11   *       http://www.gnu.org/copyleft/gpl.html
12   * or by writing to:
13   *      Free Software Foundation, Inc.
14   *      59 Temple Place - Suite 330
15   *      Boston, MA 02111-1307, USA
16   *
17   * Copyright: 2005
18   *     The copyright to this program is held by it's authors.
19   *
20   * ID: $Id: DisplaySelectEvent.java 1966 2009-10-30 01:15:14Z dmsmith $
21   */
22  package org.crosswire.bibledesktop.book;
23  
24  import java.util.EventObject;
25  
26  import org.crosswire.jsword.book.BookProvider;
27  import org.crosswire.jsword.passage.Key;
28  
29  /**
30   * A DisplaySelectEvent happens whenever a user makes a command.
31   * 
32   * @see gnu.gpl.License for license details.<br>
33   *      The copyright to this program is held by it's authors.
34   * @author Joe Walker [joe at eireneh dot com]
35   */
36  public class DisplaySelectEvent extends EventObject {
37      /**
38       * For when a command has been made
39       * 
40       * @param source
41       *            The thing that started this off
42       * @param key
43       *            The selected Key
44       */
45      public DisplaySelectEvent(BookProvider source, Key key) {
46          super(source);
47  
48          this.key = key;
49      }
50  
51      /**
52       * Get the type of command
53       * 
54       * @return The type of command
55       */
56      public Key getKey() {
57          return key;
58      }
59  
60      /**
61       * Get the type of command
62       * 
63       * @return The type of command
64       */
65      public BookProvider getBookProvider() {
66          return (BookProvider) getSource();
67      }
68  
69      /**
70       * The new passage
71       */
72      private Key key;
73  
74      /**
75       * Serialization ID
76       */
77      private static final long serialVersionUID = 3689068456540910136L;
78  }
79