~sword-devel/jsword/trunk

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
package org.crosswire.jsword.book.events;

import java.util.EventObject;

import org.crosswire.jsword.book.Book;

/**
 * A ProgressEvent happens whenever a MutableBook makes some progress
 * in generating a new Bible.
 * 
 * <p><table border='1' cellPadding='3' cellSpacing='0'>
 * <tr><td bgColor='white' class='TableRowColor'><font size='-7'>
 *
 * Distribution Licence:<br />
 * JSword is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General Public License,
 * version 2 as published by the Free Software Foundation.<br />
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.<br />
 * The License is available on the internet
 * <a href='http://www.gnu.org/copyleft/gpl.html'>here</a>, or by writing to:
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
 * MA 02111-1307, USA<br />
 * The copyright to this program is held by it's authors.
 * </font></td></tr></table>
 * @see docs.Licence
 * @author Joe Walker [joe at eireneh dot com]
 * @version $Id$
 */
public class ProgressEvent extends EventObject
{
    /**
     * Initialize a ProgressEvent
     * @param source The Object that started this off
     * @param command The command typed
     * @param lang The Progress that interprets this command
     */
    public ProgressEvent(Book source, String desc, int percent)
    {
        super(source);
        this.desc = desc;
        this.percent = percent;
    }

    /**
     * Get the total percent progress
     * @return The progress
     */
    public int getPercent()
    {
        return percent;
    }

    /**
     * Get a short descriptive phrase
     * @return The description
     */
    public String getDescription()
    {
        return desc;
    }

    /** The total progress */
    private int percent;

    /** A short descriptive phrase */
    private String desc;
}