pdf.js/web/interfaces.js
Jonas Jenwald 2a0207ccaf Enable the object-shorthand ESLint rule in web
Please see http://eslint.org/docs/rules/object-shorthand.

For the most part, these changes are of the search-and-replace kind, and the previously enabled `no-undef` rule should complement the tests in helping ensure that no stupid errors crept into to the patch.
2017-04-29 20:29:04 +02:00

122 lines
2.7 KiB
JavaScript

/* Copyright 2014 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.
*/
/* eslint-disable no-unused-vars */
'use strict';
/**
* @interface
*/
function IPDFLinkService() {}
IPDFLinkService.prototype = {
/**
* @returns {number}
*/
get page() {},
/**
* @param {number} value
*/
set page(value) {},
/**
* @param dest - The PDF destination object.
*/
navigateTo(dest) {},
/**
* @param dest - The PDF destination object.
* @returns {string} The hyperlink to the PDF object.
*/
getDestinationHash(dest) {},
/**
* @param hash - The PDF parameters/hash.
* @returns {string} The hyperlink to the PDF object.
*/
getAnchorUrl(hash) {},
/**
* @param {string} hash
*/
setHash(hash) {},
/**
* @param {string} action
*/
executeNamedAction(action) {},
/**
* @param {number} pageNum - page number.
* @param {Object} pageRef - reference to the page.
*/
cachePageRef(pageNum, pageRef) {},
};
/**
* @interface
*/
function IPDFHistory() {}
IPDFHistory.prototype = {
forward() {},
back() {},
push(params) {},
updateNextHashParam(hash) {},
};
/**
* @interface
*/
function IRenderableView() {}
IRenderableView.prototype = {
/**
* @returns {string} - Unique ID for rendering queue.
*/
get renderingId() {},
/**
* @returns {RenderingStates}
*/
get renderingState() {},
/**
* @returns {Promise} Resolved on draw completion.
*/
draw() {},
resume() {},
};
/**
* @interface
*/
function IPDFTextLayerFactory() {}
IPDFTextLayerFactory.prototype = {
/**
* @param {HTMLDivElement} textLayerDiv
* @param {number} pageIndex
* @param {PageViewport} viewport
* @param {boolean} enhanceTextSelection
* @returns {TextLayerBuilder}
*/
createTextLayerBuilder(textLayerDiv, pageIndex, viewport,
enhanceTextSelection = false) {}
};
/**
* @interface
*/
class IPDFAnnotationLayerFactory {
/**
* @param {HTMLDivElement} pageDiv
* @param {PDFPage} pdfPage
* @param {boolean} renderInteractiveForms
* @returns {AnnotationLayerBuilder}
*/
createAnnotationLayerBuilder(pageDiv, pdfPage,
renderInteractiveForms = false) {}
}