pdf.js/src/scripting_api/fullscreen.js

/* Copyright 2020 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.
 */

import { Cursor } from "./constants.js";
import { PDFObject } from "./pdf_object.js";

class FullScreen extends PDFObject {
  constructor(data) {
    super(data);

    this._backgroundColor = [];
    this._clickAdvances = true;
    this._cursor = Cursor.hidden;
    this._defaultTransition = "";
    this._escapeExits = true;
    this._isFullScreen = true;
    this._loop = false;
    this._timeDelay = 3600;
    this._usePageTiming = false;
    this._useTimer = false;
  }

  get backgroundColor() {
    return this._backgroundColor;
  }

  set backgroundColor(_) {
    /* TODO or not */
  }

  get clickAdvances() {
    return this._clickAdvances;
  }

  set clickAdvances(_) {
    /* TODO or not */
  }

  get cursor() {
    return this._cursor;
  }

  set cursor(_) {
    /* TODO or not */
  }

  get defaultTransition() {
    return this._defaultTransition;
  }

  set defaultTransition(_) {
    /* TODO or not */
  }

  get escapeExits() {
    return this._escapeExits;
  }

  set escapeExits(_) {
    /* TODO or not */
  }

  get isFullScreen() {
    return this._isFullScreen;
  }

  set isFullScreen(_) {
    /* TODO or not */
  }

  get loop() {
    return this._loop;
  }

  set loop(_) {
    /* TODO or not */
  }

  get timeDelay() {
    return this._timeDelay;
  }

  set timeDelay(_) {
    /* TODO or not */
  }

  get transitions() {
    // This list of possible value for transition has been found:
    // https://www.adobe.com/content/dam/acom/en/devnet/acrobat/pdfs/5186AcroJS.pdf#page=198
    return [
      "Replace",
      "WipeRight",
      "WipeLeft",
      "WipeDown",
      "WipeUp",
      "SplitHorizontalIn",
      "SplitHorizontalOut",
      "SplitVerticalIn",
      "SplitVerticalOut",
      "BlindsHorizontal",
      "BlindsVertical",
      "BoxIn",
      "BoxOut",
      "GlitterRight",
      "GlitterDown",
      "GlitterRightDown",
      "Dissolve",
      "Random",
    ];
  }

  set transitions(_) {
    throw new Error("fullscreen.transitions is read-only");
  }

  get usePageTiming() {
    return this._usePageTiming;
  }

  set usePageTiming(_) {
    /* TODO or not */
  }

  get useTimer() {
    return this._useTimer;
  }

  set useTimer(_) {
    /* TODO or not */
  }
}

export { FullScreen };