LSProgressEvent

implements Event

org.w3c.dom.ls.LSProgressEvent

Class Overview

This interface represents a progress event object that notifies the application about progress as a document is parsed. It extends the Event interface defined in [DOM Level 3 Events] .

The units used for the attributes position and totalSize are not specified and can be implementation and input dependent.

Summary

[Expand]

Inherited Constants

From interface org.w3c.dom.events.Event

Public Methods
abstract LSInput	getInput() The input source that is being parsed.
abstract int	getPosition() The current position in the input source, including all external entities and other resources that have been read.
abstract int	getTotalSize() The total size of the document including all external resources, this number might change as a document is being parsed if references to more external resources are seen.

[Expand]

Inherited Methods

From interface org.w3c.dom.events.Event

abstract boolean	getBubbles() Used to indicate whether or not an event is a bubbling event.
abstract boolean	getCancelable() Used to indicate whether or not an event can have its default action prevented.
abstract EventTarget	getCurrentTarget() Used to indicate the `EventTarget` whose `EventListeners` are currently being processed.
abstract short	getEventPhase() Used to indicate which phase of event flow is currently being evaluated.
abstract EventTarget	getTarget() Used to indicate the `EventTarget` to which the event was originally dispatched.
abstract long	getTimeStamp() Used to specify the time (in milliseconds relative to the epoch) at which the event was created.
abstract String	getType() The name of the event (case-insensitive).
abstract void	initEvent(String eventTypeArg, boolean canBubbleArg, boolean cancelableArg) The `initEvent` method is used to initialize the value of an `Event` created through the `DocumentEvent` interface.
abstract void	preventDefault() If an event is cancelable, the `preventDefault` method is used to signify that the event is to be canceled, meaning any default action normally taken by the implementation as a result of the event will not occur.
abstract void	stopPropagation() The `stopPropagation` method is used prevent further propagation of an event during event flow.

Public Methods

public abstract LSInput getInput ()

The input source that is being parsed.

public abstract int getPosition ()

The current position in the input source, including all external entities and other resources that have been read.

public abstract int getTotalSize ()

The total size of the document including all external resources, this number might change as a document is being parsed if references to more external resources are seen. A value of 0 is returned if the total size cannot be determined or estimated.

Interfaces