KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > w3c > dom > ls > LSProgressEvent


1 /*
2  * Copyright (c) 2004 World Wide Web Consortium,
3  *
4  * (Massachusetts Institute of Technology, European Research Consortium for
5  * Informatics and Mathematics, Keio University). All Rights Reserved. This
6  * work is distributed under the W3C(r) Software License [1] in the hope that
7  * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
8  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
9  *
10  * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
11  */
12
13 package org.w3c.dom.ls;
14
15 import org.w3c.dom.events.Event JavaDoc;
16
17 /**
18  * This interface represents a progress event object that notifies the
19  * application about progress as a document is parsed. It extends the
20  * <code>Event</code> interface defined in [<a HREF='http://www.w3.org/TR/2003/NOTE-DOM-Level-3-Events-20031107'>DOM Level 3 Events</a>]
21  * .
22  * <p> The units used for the attributes <code>position</code> and
23  * <code>totalSize</code> are not specified and can be implementation and
24  * input dependent.
25  * <p>See also the <a HREF='http://www.w3.org/TR/2004/REC-DOM-Level-3-LS-20040407'>Document Object Model (DOM) Level 3 Load
26 and Save Specification</a>.
27  */
28 public interface LSProgressEvent extends Event JavaDoc {
29     /**
30      * The input source that is being parsed.
31      */
32     public LSInput JavaDoc getInput();
33
34     /**
35      * The current position in the input source, including all external
36      * entities and other resources that have been read.
37      */
38     public int getPosition();
39
40     /**
41      * The total size of the document including all external resources, this
42      * number might change as a document is being parsed if references to
43      * more external resources are seen. A value of <code>0</code> is
44      * returned if the total size cannot be determined or estimated.
45      */
46     public int getTotalSize();
47
48 }
49
Popular Tags