| PassageListener.java |
1 /**
2 * Distribution License:
3 * JSword is free software; you can redistribute it and/or modify it under
4 * the terms of the GNU Lesser General Public License, version 2.1 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 Lesser General Public License for more details.
9 *
10 * The License is available on the internet at:
11 * http://www.gnu.org/copyleft/lgpl.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: PassageListener.java 1966 2009-10-30 01:15:14Z dmsmith $
21 */
22 package org.crosswire.jsword.passage;
23
24 import java.util.EventListener;
25
26 /**
27 * A PassageListener gets told when the verses in a Passage have changed (added
28 * or removed).
29 *
30 * @see gnu.lgpl.License for license details.<br>
31 * The copyright to this program is held by it's authors.
32 * @author Joe Walker [joe at eireneh dot com]
33 */
34 public interface PassageListener extends EventListener {
35 /**
36 * Sent after stuff has been added to the Passage, more info about what and
37 * where can be had from the Event
38 *
39 * @param ev
40 * a PassageEvent encapsulating the event information
41 */
42 void versesAdded(PassageEvent ev);
43
44 /**
45 * Sent after stuff has been removed from the Passage, more info about what
46 * and where can be had from the Event
47 *
48 * @param ev
49 * a PassageEvent encapsulating the event information
50 */
51 void versesRemoved(PassageEvent ev);
52
53 /**
54 * Sent after verses have been simultaneously added and removed from the
55 * Passage, more info about what and where can be had from the Event
56 *
57 * @param ev
58 * a PassageEvent encapsulating the event information
59 */
60 void versesChanged(PassageEvent ev);
61 }
62