Adds types definitions (jsdoc) for the PDFViewer code.

web/interfaces.js

@@ -0,0 +1,77 @@
+/* -*- Mode: Java; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* Copyright 2012 Mozilla Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+'use strict';
+
+/**
+ * @interface
+ */
+function IPDFLinkService() {}
+IPDFLinkService.prototype = {
+  /**
+   * @returns {number}
+   */
+  get page() {},
+  /**
+   * @param {number} value
+   */
+  set page(value) {},
+  /**
+   * @param dest - The PDF destination object.
+   */
+  navigateTo: function (dest) {},
+  /**
+   * @param dest - The PDF destination object.
+   * @returns {string} The hyperlink to the PDF object.
+   */
+  getDestinationHash: function (dest) {},
+  /**
+   * @param hash - The PDF parameters/hash.
+   * @returns {string} The hyperlink to the PDF object.
+   */
+  getAnchorUrl: function (hash) {},
+};
+
+/**
+ * @interface
+ */
+function IRenderableView() {}
+IRenderableView.prototype = {
+  /**
+   * @returns {string} - Unique ID for rendering queue.
+   */
+  get renderingId() {},
+  /**
+   * @returns {RenderingStates}
+   */
+  get renderingState() {},
+  /**
+   * @param {function} callback - The draw completion callback.
+   */
+  draw: function (callback) {},
+  resume: function () {},
+};
+
+/**
+ * @interface
+ */
+function ILastScrollSource() {}
+ILastScrollSource.prototype = {
+  /**
+   * @returns {number}
+   */
+  get lastScroll() {},
+};