← Back to branch summary

~sword-devel/jsword/trunk

« back to all changes in this revision

Viewing changes to jsword/java/jsword/org/crosswire/jsword/book/events/ProgressEvent.java

  • Committer: joe
  • Date: 2002-10-08 21:36:18 UTC
  • Revision ID: svn-v4:a88caf3b-7e0a-0410-8d0d-cecb45342206:trunk:80
big config and comment update

Show diffs side-by-side

added added

removed removed

Lines of Context:
jsword/java/jsword/org/crosswire/jsword/book/events/ProgressEvent.java
6
6
import org.crosswire.jsword.book.Book;
7
7
 
8
8
/**
9
 
* A ProgressEvent happens whenever a MutableBook makes some progress
10
 
* in generating a new Bible.
11
 
*
12
 
* <table border='1' cellPadding='3' cellSpacing='0' width="100%">
13
 
* <tr><td bgColor='white'class='TableRowColor'><font size='-7'>
14
 
* Distribution Licence:<br />
15
 
* Project B is free software; you can redistribute it
16
 
* and/or modify it under the terms of the GNU General Public License,
17
 
* version 2 as published by the Free Software Foundation.<br />
18
 
* This program is distributed in the hope that it will be useful,
19
 
* but WITHOUT ANY WARRANTY; without even the implied warranty of
20
 
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21
 
* General Public License for more details.<br />
22
 
* The License is available on the internet
23
 
* <a href='http://www.gnu.org/copyleft/gpl.html'>here</a>, by writing to
24
 
* <i>Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
25
 
* MA 02111-1307, USA</i>, Or locally at the Licence link below.<br />
26
 
* The copyright to this program is held by it's authors.
27
 
* </font></td></tr></table>
28
 
* @see <a href='http://www.eireneh.com/servlets/Web'>Project B Home</a>
29
 
* @see <{docs.Licence}>
30
 
* @see <{Bible}>
31
 
* @see ProgressListener
32
 
* @author Joe Walker
33
 
* @version D7.I6.T2
34
 
*/
 
9
 * A ProgressEvent happens whenever a MutableBook makes some progress
 
10
 * in generating a new Bible.
 
11
 * 
 
12
 * <p><table border='1' cellPadding='3' cellSpacing='0'>
 
13
 * <tr><td bgColor='white' class='TableRowColor'><font size='-7'>
 
14
 *
 
15
 * Distribution Licence:<br />
 
16
 * JSword is free software; you can redistribute it
 
17
 * and/or modify it under the terms of the GNU General Public License,
 
18
 * version 2 as published by the Free Software Foundation.<br />
 
19
 * This program is distributed in the hope that it will be useful,
 
20
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
21
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 
22
 * General Public License for more details.<br />
 
23
 * The License is available on the internet
 
24
 * <a href='http://www.gnu.org/copyleft/gpl.html'>here</a>, or by writing to:
 
25
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
 
26
 * MA 02111-1307, USA<br />
 
27
 * The copyright to this program is held by it's authors.
 
28
 * </font></td></tr></table>
 
29
 * @see docs.Licence
 
30
 * @author Joe Walker [joe at eireneh dot com]
 
31
 * @version $Id$
 
32
 */
35
33
public class ProgressEvent extends EventObject
36
34
{
37
35
    /**
38
 
    * Initialize a ProgressEvent
39
 
    * @param source The Object that started this off
40
 
    * @param command The command typed
41
 
    * @param lang The Progress that interprets this command
42
 
    */
 
36
     * Initialize a ProgressEvent
 
37
     * @param source The Object that started this off
 
38
     * @param command The command typed
 
39
     * @param lang The Progress that interprets this command
 
40
     */
43
41
    public ProgressEvent(Book source, String desc, int percent)
44
42
    {
45
43
        super(source);
48
46
    }
49
47
 
50
48
    /**
51
 
    * Get the total percent progress
52
 
    * @return The progress
53
 
    */
 
49
     * Get the total percent progress
 
50
     * @return The progress
 
51
     */
54
52
    public int getPercent()
55
53
    {
56
54
        return percent;
57
55
    }
58
56
 
59
57
    /**
60
 
    * Get a short descriptive phrase
61
 
    * @return The description
62
 
    */
 
58
     * Get a short descriptive phrase
 
59
     * @return The description
 
60
     */
63
61
    public String getDescription()
64
62
    {
65
63
        return desc;