CellML API
cellml_api::DOMURLLoader Interface Reference
A DOM specific interface for loading a Document by URL. More...
Public Member Functions | |
| dom::Document | loadDocument (in dom::DOMString URL) raises (CellMLException) |
| Loads an XML formatted document from a given URL into a DOM. | |
| dom::Document | loadDocumentFromText (in dom::DOMString xmlText) raises (CellMLException) |
| Loads an XML formatted document from the given serialised text into a DOM representation. | |
| void | asyncLoadDocument (in dom::DOMString URL, in DocumentLoadedListener listener) raises (CellMLException) |
| Asynchronously loads an XML formatted document from a given URL into a DOM. | |
 Public Member Functions inherited from XPCOM::IObject | |
| void | add_ref () |
| Called to indicate that some code is keeping an owning reference to the object. | |
| oneway void | release_ref () |
| Removes a reference to an object which was created by some other means (e.g. | |
| IObject | query_interface (in utf8string id) |
| Returns an IObject of the same implementation, which supports a specific interface. | |
Public Attributes | |
| readonly attribute dom::DOMString | lastErrorMessage |
| An error message describing the cause of the last CellMLException. | |
| Public Attributes inherited from XPCOM::IObject | |
| readonly attribute string | objid |
| Fetches the ID of the object. | |
Detailed Description
A DOM specific interface for loading a Document by URL.
Definition at line 2051 of file CellML_APISPEC.idl.
Member Function Documentation
| void cellml_api::DOMURLLoader::asyncLoadDocument | ( | in dom::DOMString | URL, |
| in DocumentLoadedListener | listener | ||
| ) | raises (CellMLException) |
Asynchronously loads an XML formatted document from a given URL into a DOM.
This may be restricted to certain URLs due to security restrictions on some remotely hosted URL loaders.
- Parameters
-
URL The URL from which to load the document. listener The listener to notify when the load completes. CellMLException if the model cannot be loaded.
| dom::Document cellml_api::DOMURLLoader::loadDocument | ( | in dom::DOMString | URL | ) | raises (CellMLException) |
Loads an XML formatted document from a given URL into a DOM.
This may be restricted to certain URLs due to security restrictions on some remotely hosted URL loaders.
- Parameters
-
URL The URL from which to load the document.
- Returns
- The loaded document. CellMLException if the model cannot be loaded.
| dom::Document cellml_api::DOMURLLoader::loadDocumentFromText | ( | in dom::DOMString | xmlText | ) | raises (CellMLException) |
Loads an XML formatted document from the given serialised text into a DOM representation.
- Parameters
-
xmlText The serialised XML used to create the document.
- Returns
- The loaded document. CellMLException if the model cannot be loaded.
Member Data Documentation
| readonly attribute dom::DOMString cellml_api::DOMURLLoader::lastErrorMessage |
An error message describing the cause of the last CellMLException.
The error message is formatted code/param1/param2/.../paramn Any error message the application desires may be placed in lastErrorMessage and it will be passed on to other API lastErrorMessage attributes.
An API provided implementation may return the following error message types: noperm (The user does not have permission to load URLs of this kind). badurl (The URL was malformed). servererror/info A server error occurred. Info is an optional, method specific parameter, and for HTTP it should be the server error number. badxml/line/column/msg The XML was malformed. Line an column give the location in the file at which the error occurred. msg is the message from the processor stating what is wrong.
Definition at line 2104 of file CellML_APISPEC.idl.