aboutsummaryrefslogtreecommitdiff
path: root/tools/addon-sdk-1.7/packages/api-utils/docs/content/loader.md
diff options
context:
space:
mode:
Diffstat (limited to 'tools/addon-sdk-1.7/packages/api-utils/docs/content/loader.md')
-rw-r--r--tools/addon-sdk-1.7/packages/api-utils/docs/content/loader.md92
1 files changed, 0 insertions, 92 deletions
diff --git a/tools/addon-sdk-1.7/packages/api-utils/docs/content/loader.md b/tools/addon-sdk-1.7/packages/api-utils/docs/content/loader.md
deleted file mode 100644
index a460476..0000000
--- a/tools/addon-sdk-1.7/packages/api-utils/docs/content/loader.md
+++ /dev/null
@@ -1,92 +0,0 @@
-<!-- This Source Code Form is subject to the terms of the Mozilla Public
- - License, v. 2.0. If a copy of the MPL was not distributed with this
- - file, You can obtain one at http://mozilla.org/MPL/2.0/. -->
-
-<!-- contributed by Irakli Gozalishvili [gozala@mozilla.com] -->
-
-Loader is base trait and it provides set of core properties and associated
-validations. Trait is useful for all the compositions providing high level
-APIs for creating JavaScript contexts that can access web content.
-
-Loader is composed from the
-[EventEmitter](packages/api-utils/events.html) trait, therefore
-instances of Loader and their descendants expose all the public properties
-exposed by EventEmitter along with additional public properties:
-
-Value changes on all of the above mentioned properties emit `propertyChange`
-events on an instances.
-
-**Example:**
-
-The following code creates a wrapper on hidden frame that reloads a web page
-in frame every time `contentURL` property is changed:
-
- var hiddenFrames = require("hidden-frame");
- var { Loader } = require("content");
- var PageLoader = Loader.compose({
- constructor: function PageLoader(options) {
- options = options || {};
- if (options.contentURL)
- this.contentURL = options.contentURL;
- this.on('propertyChange', this._onChange = this._onChange.bind(this));
- let self = this;
- hiddenFrames.add(hiddenFrames.HiddenFrame({
- onReady: function onReady() {
- let frame = self._frame = this.element;
- self._emit('propertyChange', { contentURL: self.contentURL });
- }
- }));
- },
- _onChange: function _onChange(e) {
- if ('contentURL' in e)
- this._frame.setAttribute('src', this._contentURL);
- }
- });
-
-<api name="Loader">
-@class
-<api name="contentScriptFile">
-@property {array}
-The local file URLs of content scripts to load. Content scripts specified by
-this property are loaded *before* those specified by the `contentScript`
-property.
-</api>
-
-<api name="contentScript">
-@property {array}
-The texts of content scripts to load. Content scripts specified by this
-property are loaded *after* those specified by the `contentScriptFile` property.
-</api>
-
-<api name="contentScriptWhen">
-@property {string}
-When to load the content scripts. This may take one of the following
-values:
-
-* "start": load content scripts immediately after the document
-element for the page is inserted into the DOM, but before the DOM content
-itself has been loaded
-* "ready": load content scripts once DOM content has been loaded,
-corresponding to the
-[DOMContentLoaded](https://developer.mozilla.org/en/Gecko-Specific_DOM_Events)
-event
-* "end": load content scripts once all the content (DOM, JS, CSS,
-images) for the page has been loaded, at the time the
-[window.onload event](https://developer.mozilla.org/en/DOM/window.onload)
-fires
-
-</api>
-
-<api name="contentURL">
-@property {string}
-The URL of the content loaded.
-</api>
-
-<api name="allow">
-@property {object}
-Permissions for the content, with the following keys:
-@prop script {boolean}
- Whether or not to execute script in the content. Defaults to true.
-</api>
-</api>
-