mozilla

nsIDocumentLoader

This article is in need of a technical review.

This interface responsible for tracking groups of loads that belong together (images, external scripts, and so on.) and subdocuments (iframe, frame, and so on.). It is also responsible for sending nsIWebProgressListener notifications.
Inherits from: nsISupports Last changed in Gecko 1.8 (Firefox 1.5 / Thunderbird 1.5 / SeaMonkey 1.0)

Implemented by: @mozilla.org/docloaderservice;1. To create an instance, use:

var documentLoader = Components.classes["@mozilla.org/docloaderservice;1"]
                     .createInstance(Components.interfaces.nsIDocumentLoader);

Method overview

void clearParentDocLoader(); Obsolete since Gecko 1.8
void createDocumentLoader(out nsIDocumentLoader anInstance); Obsolete since Gecko 1.8
void destroy(); Obsolete since Gecko 1.8
void fireOnLocationChange(in nsIWebProgress aWebProgress, in nsIRequest aRequest, in nsIURI aUri); Obsolete since Gecko 1.8
void fireOnStatusChange(in nsIWebProgress aWebProgress, in nsIRequest aRequest, in nsresult aStatus, in wstring aMessage); Obsolete since Gecko 1.8
void getContentViewerContainer(in nsISupports aDocumentID, out nsIContentViewerContainer aResult); Native code only! Obsolete since Gecko 1.8
nsILoadGroup getLoadGroup(); Obsolete since Gecko 1.8
boolean isBusy(); Obsolete since Gecko 1.8
void stop();

Attributes

Attribute Type Description
container nsISupports Read only.
documentChannel nsIChannel Read only.
loadGroup nsILoadGroup Read only.

Methods

Obsolete since Gecko 1.8 (Firefox 1.5 / Thunderbird 1.5 / SeaMonkey 1.0)

clearParentDocLoader()

void clearParentDocLoader();
Parameters

None.

Obsolete since Gecko 1.8 (Firefox 1.5 / Thunderbird 1.5 / SeaMonkey 1.0)

createDocumentLoader()

void createDocumentLoader(
  out nsIDocumentLoader anInstance
);
Parameters
anInstance
 

Obsolete since Gecko 1.8 (Firefox 1.5 / Thunderbird 1.5 / SeaMonkey 1.0)

destroy()

void destroy();
Parameters

None.

Obsolete since Gecko 1.8 (Firefox 1.5 / Thunderbird 1.5 / SeaMonkey 1.0)

fireOnLocationChange()

void fireOnLocationChange(
  in nsIWebProgress aWebProgress,
  in nsIRequest aRequest,
  in nsIURI aUri
);
Parameters
aWebProgress
 
aRequest
 
aUri
 

Obsolete since Gecko 1.8 (Firefox 1.5 / Thunderbird 1.5 / SeaMonkey 1.0)

fireOnStatusChange()

void fireOnStatusChange(
  in nsIWebProgress aWebProgress,
  in nsIRequest aRequest,
  in nsresult aStatus,
  in wstring aMessage
);
Parameters
aWebProgress
 
aRequest
 
aStatus
 
aMessage
 

Native code only!

getContentViewerContainer

Obsolete since Gecko 1.8 (Firefox 1.5 / Thunderbird 1.5 / SeaMonkey 1.0)
This feature is obsolete. Although it may still work in some browsers, its use is discouraged since it could be removed at any time. Try to avoid using it.

void getContentViewerContainer(
  in nsISupports aDocumentID,
  out nsIContentViewerContainer aResult
);
Parameters
aDocumentID
 
aResult
 

Obsolete since Gecko 1.8 (Firefox 1.5 / Thunderbird 1.5 / SeaMonkey 1.0)

getLoadGroup()

nsILoadGroup getLoadGroup();
Parameters

None.

Return value

 

Obsolete since Gecko 1.8 (Firefox 1.5 / Thunderbird 1.5 / SeaMonkey 1.0)

isBusy()

boolean isBusy();
Parameters

None.

Return value

 

stop()

void stop();
Parameters

None.

Document Tags and Contributors

Contributors to this page: Sheppy, fscholz, trevorh, kscarfone
Last updated by: Sheppy,