nsIURILoader

IID:40AECB53-8B65-11d3-989D-001083010E9B
Inherits From:nsISupports

The uri dispatcher is responsible for taking uri's, determining the content and routing the opened url to the correct content handler.

When you encounter a url you want to open, you typically call openURI, passing it the content listener for the window the uri is originating from. The uri dispatcher opens the url to discover the content type. It then gives the content listener first crack at handling the content. If it doesn't want it, the dispatcher tries to hand it off one of the registered content listeners. This allows running applications the chance to jump in and handle the content.

If that also fails, then the uri dispatcher goes to the registry looking for the preferred content handler for the content type of the uri. The content handler may create an app instance or it may hand the contents off to a platform specific plugin or helper app. Or it may hand the url off to an OS registered application.

This interface is implemented by the following components:


Methods

nsIDocumentLoader getDocumentLoaderForContext ( nsISupports windowContext ) nsILoadGroup getLoadGroupForContext ( nsISupports windowContext ) void openURI ( nsIChannel channel , PRBool isContentPreferred , nsISupports windowContext ) void registerContentListener ( nsIURIContentListener contentListener ) void stop ( nsISupports loadCookie ) void unRegisterContentListener ( nsIURIContentListener contentListener )

nsIDocumentLoader getDocumentLoaderForContext ( nsISupports windowContext )

Arguments:
windowContext

nsILoadGroup getLoadGroupForContext ( nsISupports windowContext )

Dirty little back door for sneaking the load group out in case you need it to create the channel before calling openURI

Arguments:
windowContext

void openURI ( nsIChannel channel , PRBool isContentPreferred , nsISupports windowContext )

OpenURI requires the following parameters.....

Arguments:
channel: The channel that should be opened. This must not be asyncOpen'd yet!
isContentPreferred: Should the content be displayed in a container that prefers the content-type, or will any container do.
windowContext: If you are running the url from a doc shell or a web shell, this is your window context. If you have a content listener you want to give first crack to, the uri loader needs to be able to get it from the window context (we'll use nsIInterfaceRequestor). We will also be using nsIInterfaceRequestor to get at the progress event sink interface.

void registerContentListener ( nsIURIContentListener contentListener )

As applications such as messenger and the browser are instantiated, they register content listener's with the uri dispatcher corresponding to content windows within that application.

Note to self: we may want to optimize things a bit more by requiring the content types the registered content listener cares about.

Arguments:
contentListener: the listener to register

void stop ( nsISupports loadCookie )

Stops an in progress load

Arguments:
loadCookie

void unRegisterContentListener ( nsIURIContentListener contentListener )

Arguments:
contentListener

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com