Yu Cong
44db9807a1
Some checks failed
Types tests / Test (lts/*) (push) Has been cancelled
Lint / Lint (lts/*) (push) Has been cancelled
CodeQL / Analyze (javascript) (push) Has been cancelled
CI / Test (20) (push) Has been cancelled
CI / Test (22) (push) Has been cancelled
CI / Test (24) (push) Has been cancelled
324 lines
9.9 KiB
JavaScript
324 lines
9.9 KiB
JavaScript
/* 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.
|
|
*/
|
|
|
|
/** @typedef {import("./event_utils.js").EventBus} EventBus */
|
|
|
|
import {
|
|
CursorTool,
|
|
ScrollMode,
|
|
SpreadMode,
|
|
toggleCheckedBtn,
|
|
toggleExpandedBtn,
|
|
} from "./ui_utils.js";
|
|
import { PagesCountLimit } from "./pdf_viewer.js";
|
|
|
|
/**
|
|
* @typedef {Object} SecondaryToolbarOptions
|
|
* @property {HTMLDivElement} toolbar - Container for the secondary toolbar.
|
|
* @property {HTMLButtonElement} toggleButton - Button to toggle the visibility
|
|
* of the secondary toolbar.
|
|
* @property {HTMLButtonElement} presentationModeButton - Button for entering
|
|
* presentation mode.
|
|
* @property {HTMLButtonElement} openFileButton - Button to open a file.
|
|
* @property {HTMLButtonElement} printButton - Button to print the document.
|
|
* @property {HTMLButtonElement} downloadButton - Button to download the
|
|
* document.
|
|
* @property {HTMLAnchorElement} viewBookmarkButton - Button to obtain a
|
|
* bookmark link to the current location in the document.
|
|
* @property {HTMLButtonElement} firstPageButton - Button to go to the first
|
|
* page in the document.
|
|
* @property {HTMLButtonElement} lastPageButton - Button to go to the last page
|
|
* in the document.
|
|
* @property {HTMLButtonElement} pageRotateCwButton - Button to rotate the pages
|
|
* clockwise.
|
|
* @property {HTMLButtonElement} pageRotateCcwButton - Button to rotate the
|
|
* pages counterclockwise.
|
|
* @property {HTMLButtonElement} cursorSelectToolButton - Button to enable the
|
|
* select tool.
|
|
* @property {HTMLButtonElement} cursorHandToolButton - Button to enable the
|
|
* hand tool.
|
|
* @property {HTMLButtonElement} imageAltTextSettingsButton - Button for opening
|
|
* the image alt-text settings dialog.
|
|
* @property {HTMLButtonElement} documentPropertiesButton - Button for opening
|
|
* the document properties dialog.
|
|
*/
|
|
|
|
class SecondaryToolbar {
|
|
#opts;
|
|
|
|
/**
|
|
* @param {SecondaryToolbarOptions} options
|
|
* @param {EventBus} eventBus
|
|
*/
|
|
constructor(options, eventBus) {
|
|
this.#opts = options;
|
|
const buttons = [
|
|
{
|
|
element: options.presentationModeButton,
|
|
eventName: "presentationmode",
|
|
close: true,
|
|
},
|
|
{ element: options.printButton, eventName: "print", close: true },
|
|
{ element: options.downloadButton, eventName: "download", close: true },
|
|
{ element: options.viewBookmarkButton, eventName: null, close: true },
|
|
{ element: options.firstPageButton, eventName: "firstpage", close: true },
|
|
{ element: options.lastPageButton, eventName: "lastpage", close: true },
|
|
{
|
|
element: options.pageRotateCwButton,
|
|
eventName: "rotatecw",
|
|
close: false,
|
|
},
|
|
{
|
|
element: options.pageRotateCcwButton,
|
|
eventName: "rotateccw",
|
|
close: false,
|
|
},
|
|
{
|
|
element: options.cursorSelectToolButton,
|
|
eventName: "switchcursortool",
|
|
eventDetails: { tool: CursorTool.SELECT },
|
|
close: true,
|
|
},
|
|
{
|
|
element: options.cursorHandToolButton,
|
|
eventName: "switchcursortool",
|
|
eventDetails: { tool: CursorTool.HAND },
|
|
close: true,
|
|
},
|
|
{
|
|
element: options.scrollPageButton,
|
|
eventName: "switchscrollmode",
|
|
eventDetails: { mode: ScrollMode.PAGE },
|
|
close: true,
|
|
},
|
|
{
|
|
element: options.scrollVerticalButton,
|
|
eventName: "switchscrollmode",
|
|
eventDetails: { mode: ScrollMode.VERTICAL },
|
|
close: true,
|
|
},
|
|
{
|
|
element: options.scrollHorizontalButton,
|
|
eventName: "switchscrollmode",
|
|
eventDetails: { mode: ScrollMode.HORIZONTAL },
|
|
close: true,
|
|
},
|
|
{
|
|
element: options.scrollWrappedButton,
|
|
eventName: "switchscrollmode",
|
|
eventDetails: { mode: ScrollMode.WRAPPED },
|
|
close: true,
|
|
},
|
|
{
|
|
element: options.spreadNoneButton,
|
|
eventName: "switchspreadmode",
|
|
eventDetails: { mode: SpreadMode.NONE },
|
|
close: true,
|
|
},
|
|
{
|
|
element: options.spreadOddButton,
|
|
eventName: "switchspreadmode",
|
|
eventDetails: { mode: SpreadMode.ODD },
|
|
close: true,
|
|
},
|
|
{
|
|
element: options.spreadEvenButton,
|
|
eventName: "switchspreadmode",
|
|
eventDetails: { mode: SpreadMode.EVEN },
|
|
close: true,
|
|
},
|
|
{
|
|
element: options.imageAltTextSettingsButton,
|
|
eventName: "imagealttextsettings",
|
|
close: true,
|
|
},
|
|
{
|
|
element: options.documentPropertiesButton,
|
|
eventName: "documentproperties",
|
|
close: true,
|
|
},
|
|
];
|
|
if (typeof PDFJSDev === "undefined" || PDFJSDev.test("GENERIC")) {
|
|
buttons.push({
|
|
element: options.openFileButton,
|
|
eventName: "openfile",
|
|
close: true,
|
|
});
|
|
}
|
|
|
|
this.eventBus = eventBus;
|
|
this.opened = false;
|
|
|
|
// Bind the event listeners for click, cursor tool, and scroll/spread mode
|
|
// actions.
|
|
this.#bindListeners(buttons);
|
|
|
|
this.reset();
|
|
}
|
|
|
|
/**
|
|
* @type {boolean}
|
|
*/
|
|
get isOpen() {
|
|
return this.opened;
|
|
}
|
|
|
|
setPageNumber(pageNumber) {
|
|
this.pageNumber = pageNumber;
|
|
this.#updateUIState();
|
|
}
|
|
|
|
setPagesCount(pagesCount) {
|
|
this.pagesCount = pagesCount;
|
|
this.#updateUIState();
|
|
}
|
|
|
|
reset() {
|
|
this.pageNumber = 0;
|
|
this.pagesCount = 0;
|
|
this.#updateUIState();
|
|
|
|
// Reset the Scroll/Spread buttons too, since they're document specific.
|
|
this.eventBus.dispatch("switchcursortool", { source: this, reset: true });
|
|
this.#scrollModeChanged({ mode: ScrollMode.VERTICAL });
|
|
this.#spreadModeChanged({ mode: SpreadMode.NONE });
|
|
}
|
|
|
|
#updateUIState() {
|
|
const {
|
|
firstPageButton,
|
|
lastPageButton,
|
|
pageRotateCwButton,
|
|
pageRotateCcwButton,
|
|
} = this.#opts;
|
|
|
|
firstPageButton.disabled = this.pageNumber <= 1;
|
|
lastPageButton.disabled = this.pageNumber >= this.pagesCount;
|
|
pageRotateCwButton.disabled = this.pagesCount === 0;
|
|
pageRotateCcwButton.disabled = this.pagesCount === 0;
|
|
}
|
|
|
|
#bindListeners(buttons) {
|
|
const { eventBus } = this;
|
|
const { toggleButton } = this.#opts;
|
|
// Button to toggle the visibility of the secondary toolbar.
|
|
toggleButton.addEventListener("click", this.toggle.bind(this));
|
|
|
|
// All items within the secondary toolbar.
|
|
for (const { element, eventName, close, eventDetails } of buttons) {
|
|
element.addEventListener("click", evt => {
|
|
if (eventName !== null) {
|
|
eventBus.dispatch(eventName, { source: this, ...eventDetails });
|
|
}
|
|
if (close) {
|
|
this.close();
|
|
}
|
|
eventBus.dispatch("reporttelemetry", {
|
|
source: this,
|
|
details: {
|
|
type: "buttons",
|
|
data: { id: element.id },
|
|
},
|
|
});
|
|
});
|
|
}
|
|
|
|
eventBus._on("cursortoolchanged", this.#cursorToolChanged.bind(this));
|
|
eventBus._on("scrollmodechanged", this.#scrollModeChanged.bind(this));
|
|
eventBus._on("spreadmodechanged", this.#spreadModeChanged.bind(this));
|
|
}
|
|
|
|
#cursorToolChanged({ tool, disabled }) {
|
|
const { cursorSelectToolButton, cursorHandToolButton } = this.#opts;
|
|
|
|
toggleCheckedBtn(cursorSelectToolButton, tool === CursorTool.SELECT);
|
|
toggleCheckedBtn(cursorHandToolButton, tool === CursorTool.HAND);
|
|
|
|
cursorSelectToolButton.disabled = disabled;
|
|
cursorHandToolButton.disabled = disabled;
|
|
}
|
|
|
|
#scrollModeChanged({ mode }) {
|
|
const {
|
|
scrollPageButton,
|
|
scrollVerticalButton,
|
|
scrollHorizontalButton,
|
|
scrollWrappedButton,
|
|
spreadNoneButton,
|
|
spreadOddButton,
|
|
spreadEvenButton,
|
|
} = this.#opts;
|
|
|
|
toggleCheckedBtn(scrollPageButton, mode === ScrollMode.PAGE);
|
|
toggleCheckedBtn(scrollVerticalButton, mode === ScrollMode.VERTICAL);
|
|
toggleCheckedBtn(scrollHorizontalButton, mode === ScrollMode.HORIZONTAL);
|
|
toggleCheckedBtn(scrollWrappedButton, mode === ScrollMode.WRAPPED);
|
|
|
|
// Permanently *disable* the Scroll buttons when PAGE-scrolling is being
|
|
// enforced for *very* long/large documents; please see the `BaseViewer`.
|
|
const forceScrollModePage =
|
|
this.pagesCount > PagesCountLimit.FORCE_SCROLL_MODE_PAGE;
|
|
scrollPageButton.disabled = forceScrollModePage;
|
|
scrollVerticalButton.disabled = forceScrollModePage;
|
|
scrollHorizontalButton.disabled = forceScrollModePage;
|
|
scrollWrappedButton.disabled = forceScrollModePage;
|
|
|
|
// Temporarily *disable* the Spread buttons when horizontal scrolling is
|
|
// enabled, since the non-default Spread modes doesn't affect the layout.
|
|
const isHorizontal = mode === ScrollMode.HORIZONTAL;
|
|
spreadNoneButton.disabled = isHorizontal;
|
|
spreadOddButton.disabled = isHorizontal;
|
|
spreadEvenButton.disabled = isHorizontal;
|
|
}
|
|
|
|
#spreadModeChanged({ mode }) {
|
|
const { spreadNoneButton, spreadOddButton, spreadEvenButton } = this.#opts;
|
|
|
|
toggleCheckedBtn(spreadNoneButton, mode === SpreadMode.NONE);
|
|
toggleCheckedBtn(spreadOddButton, mode === SpreadMode.ODD);
|
|
toggleCheckedBtn(spreadEvenButton, mode === SpreadMode.EVEN);
|
|
}
|
|
|
|
open() {
|
|
if (this.opened) {
|
|
return;
|
|
}
|
|
this.opened = true;
|
|
|
|
const { toggleButton, toolbar } = this.#opts;
|
|
toggleExpandedBtn(toggleButton, true, toolbar);
|
|
}
|
|
|
|
close() {
|
|
if (!this.opened) {
|
|
return;
|
|
}
|
|
this.opened = false;
|
|
|
|
const { toggleButton, toolbar } = this.#opts;
|
|
toggleExpandedBtn(toggleButton, false, toolbar);
|
|
}
|
|
|
|
toggle() {
|
|
if (this.opened) {
|
|
this.close();
|
|
} else {
|
|
this.open();
|
|
}
|
|
}
|
|
}
|
|
|
|
export { SecondaryToolbar };
|