36 * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
37 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
38 *
39 * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
40 */
41
42 package org.w3c.dom.ls;
43
44 import org.w3c.dom.events.Event;
45
46 /**
47 * This interface represents a progress event object that notifies the
48 * application about progress as a document is parsed. It extends the
49 * <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>]
50 * .
51 * <p> The units used for the attributes <code>position</code> and
52 * <code>totalSize</code> are not specified and can be implementation and
53 * input dependent.
54 * <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
55 and Save Specification</a>.
56 */
57 public interface LSProgressEvent extends Event {
58 /**
59 * The input source that is being parsed.
60 */
61 public LSInput getInput();
62
63 /**
64 * The current position in the input source, including all external
65 * entities and other resources that have been read.
66 */
67 public int getPosition();
68
69 /**
70 * The total size of the document including all external resources, this
71 * number might change as a document is being parsed if references to
72 * more external resources are seen. A value of <code>0</code> is
73 * returned if the total size cannot be determined or estimated.
74 */
75 public int getTotalSize();
|
36 * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
37 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
38 *
39 * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
40 */
41
42 package org.w3c.dom.ls;
43
44 import org.w3c.dom.events.Event;
45
46 /**
47 * This interface represents a progress event object that notifies the
48 * application about progress as a document is parsed. It extends the
49 * <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>]
50 * .
51 * <p> The units used for the attributes <code>position</code> and
52 * <code>totalSize</code> are not specified and can be implementation and
53 * input dependent.
54 * <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
55 and Save Specification</a>.
56 *
57 * @since 1.5
58 */
59 public interface LSProgressEvent extends Event {
60 /**
61 * The input source that is being parsed.
62 */
63 public LSInput getInput();
64
65 /**
66 * The current position in the input source, including all external
67 * entities and other resources that have been read.
68 */
69 public int getPosition();
70
71 /**
72 * The total size of the document including all external resources, this
73 * number might change as a document is being parsed if references to
74 * more external resources are seen. A value of <code>0</code> is
75 * returned if the total size cannot be determined or estimated.
76 */
77 public int getTotalSize();
|