Изменение XPS-страницы событий | Java

Понимание событийного подхода в программировании

Событийный подход в программировании — это парадигма, ориентированная на события и их обработку. В этой модели ход программы определяется событиями, которые могут включать действия пользователя (например, щелчки мыши или нажатия клавиш), уведомления, генерируемые системой, или сообщения от других приложений. Ниже приведены некоторые ключевые аспекты событийно-ориентированного подхода:

• События: События обозначают важные события в программе. Они могут включать взаимодействие с пользователем, изменения данных или сообщения от различных компонентов системы. Например, нажатие кнопки или загрузка файла могут вызвать события.

• Прослушиватели событий. Для обработки событий программисты используют прослушиватели событий (или обработчики). Это функции или методы, предназначенные для запуска при возникновении определенного события. Например, прослушиватель событий можно настроить на выполнение функции, когда пользователь нажимает кнопку.

• Асинхронное выполнение. Модель на основе событий обычно облегчает асинхронное программирование, позволяя программам сохранять оперативность во время ожидания событий. Например, веб-приложение может продолжать работать, ожидая данных от сервера.

• Развязка. Подход, основанный на событиях, способствует разделению различных компонентов программы. Эти компоненты могут взаимодействовать посредством событий, не требуя знания деталей реализации друг друга, что приводит к созданию более модульного и удобного в сопровождении кода.

• Распространенные случаи использования. Программирование, управляемое событиями, обычно применяется в графических интерфейсах пользователя (GUI), веб-приложениях и системах, требующих взаимодействия в реальном времени. Платформы и библиотеки, такие как Node.js, React и многие другие, используют шаблоны, управляемые событиями.

• Управление состоянием. В системе, управляемой событиями, крайне важно эффективное управление состоянием, поскольку приложение может находиться в различных состояниях в зависимости от действий пользователя или событий. Соответствующие стратегии управления состоянием обычно реализуются для обеспечения правильной работы приложения.

В целом, подход, основанный на событиях, является эффективным методом управления взаимодействиями и рабочими процессами внутри программы, что делает его особенно подходящим для приложений, требующих оперативности и взаимодействия с пользователем.

Преобразование документов XPS и события

Когда вам нужно изменить определенную страницу документа XPS с помощью API Aspose.Page, вы обычно выбираете активный документ (если в файле XPS несколько документов), выбираете активную страницу, а затем применяете изменения.

Теперь предположим, что вам нужно реализовать повторяющиеся изменения на всех страницах файла XPS и впоследствии преобразовать результат в формат PDF или изображение. Примеры таких изменений могут включать добавление водяных знаков на страницы или вставку навигационных гиперссылок. Простой метод внесения таких изменений включает в себя просмотр документов в пакете XPS, просмотр страниц текущего активного документа и затем, наконец, применение ваших изменений. Таким образом, код для решения этой задачи будет выглядеть следующим образом:

for (int i = 1; i <= document.getDocumentCount(); i++)
{
    document.selectActiveDocument(i);
    for (j = 1; j <= document.getPageCount(); j++)
    {
        document.selectActivePage(j);
        // Your changes ...
    }
}
document.saveAsPdf("file-name.pdf", saveOptions);

Если вам также необходимо внести некоторые нерегулярные изменения перед применением повторяющихся, этот подход может привести к путанице или чрезмерному перемещению по документам и страницам. Кроме того, эти петли могут показаться несколько громоздкими. Когда вы конвертируете документ XPS в PDF или изображение, процесс происходит по одной странице за раз. Когда задание преобразования готовится к обработке следующей страницы, оно запускает событие «до страницы». Пользователь может определить поведение (обработку событий) для таких событий, расширив класс BeforePageSavingEventHandler, тем самым воспользовавшись некоторыми преимуществами, обсуждаемыми во вводном разделе этой статьи.

Пример добавления навигационных гиперссылок

В этом разделе мы представим пример навигационных гиперссылок. И чтобы немного усложнить задачу, мы преобразуем в PDF только часть всех страниц, как определено методом PdfSaveOptions.setPageNumbers().

Класс обработчика событий

Ниже показано расширение класса BeforePageSavingEventHandler:

// The class to handle the before-page event while converting an XPS document.
private static class NavigationInjector extends BeforePageSavingEventHandler {
    // The font in which navigation hyperlinks and page numbers will be displayed.
    private final XpsFont font;
    // The page numbers to convert.
    private final TreeMap<Integer, Integer> pageNumbers;

    public NavigationInjector(XpsFont font, int[] pageNumbers) {
        this.font = font;
        if (pageNumbers == null) {
            this.pageNumbers = null;
            return;
        }

        // Turn the page number array into a sorted collection of unique values.
        this.pageNumbers = new TreeMap<>();
        for (int pn : pageNumbers) {
            this.pageNumbers.put(pn, 0);
        }
    }

    /**
     * The action itself to be triggered on a before-page event.
     *
     * @param args The event arguments.
     */
    @Override
    public void handle(BeforeSavingEventArgs<PageAPI> args) {
        PageAPI api = args.getElementAPI();

        XpsGlyphs glyphs;
        // For all pages in the output PDF except the first one...
        if (args.getOutputPageNumber() > 1) {
            // ...insert a hyperlink to the first page...
            glyphs = api.createGlyphs(font, 15f, 5f, api.getHeight() - 10f, "[First]");
            glyphs.setFill(api.createSolidColorBrush(Color.BLUE));
            glyphs.setHyperlinkTarget(new XpsPageLinkTarget(pageNumbers == null ? 1 : pageNumbers.firstKey()));
            api.add(glyphs);

            // ...and to the previous page.
            glyphs = api.createGlyphs(font, 15f, 60f, api.getHeight() - 10f, "[Prev]");
            glyphs.setFill(api.createSolidColorBrush(Color.BLUE));
            glyphs.setHyperlinkTarget(new XpsPageLinkTarget(
                pageNumbers == null ? args.getAbsolutePageNumber() - 1 : 
                pageNumbers.keySet().toArray(new Integer[0])[args.getOutputPageNumber() - 2]));
            api.add(glyphs);
        }

        // For all pages in the output PDF except the last one...
        if ((pageNumbers != null && args.getOutputPageNumber() < pageNumbers.size()) ||
            (pageNumbers == null && args.getOutputPageNumber() < api.getTotalPageCount())) {
            // ...insert a hyperlink to the next page...
            glyphs = api.createGlyphs(font, 15f, 110f, api.getHeight() - 10f, "[Next]");
            glyphs.setFill(api.createSolidColorBrush(Color.BLUE));
            glyphs.setHyperlinkTarget(new XpsPageLinkTarget(
                pageNumbers == null ? args.getAbsolutePageNumber() + 1 : 
                pageNumbers.keySet().toArray(new Integer[0])[args.getOutputPageNumber()]));
            api.add(glyphs);

            // ...and to the last page.
            glyphs = api.createGlyphs(font, 15f, 160f, api.getHeight() - 10f, "[Last]");
            glyphs.setFill(api.createSolidColorBrush(Color.BLUE));
            glyphs.setHyperlinkTarget(new XpsPageLinkTarget(
                pageNumbers == null ? api.getTotalPageCount() : 
                pageNumbers.lastKey()));
            api.add(glyphs);
        }

        // Insert a page number in the bottom-right corner.
        glyphs = api.createGlyphs(font, 15f, api.getWidth() - 20f, api.getHeight() - 10f, 
            String.valueOf(args.getOutputPageNumber()));
        glyphs.setFill(api.createSolidColorBrush(Color.BLACK));
        api.add(glyphs);

        // Add an outline entry to display the links to the converted pages in the navigation pane of a PDF viewer.
        api.addOutlineEntry(String.format("Page %d", args.getOutputPageNumber()), 1, args.getAbsolutePageNumber());
    }
}

Класс-обработчик должен знать о страницах, которые мы собираемся сохранить в формате PDF, чтобы установить правильные цели гиперссылок. Следовательно, конструктор должен принимать свойство массива options getPageNumbers() в качестве аргумента. Если предоставлен массив номеров страниц, мы создаем их отсортированную коллекцию, одновременно исключая дубликаты. Кроме того, классу нужен объект XpsFont, содержащий данные шрифта для текста гиперссылки.

Все это происходит в переопределенном методе handle(). Аргументом метода является объект, который содержит API модификации для текущей страницы, номер документа в пакете XPS, абсолютный номер страницы во всех документах, относительный номер страницы в текущем документе (который равен предыдущий номер, если в пакете только один документ) и номер выходной страницы (который равен абсолютному номеру страницы при преобразовании всего пакета).

Логика следующих двух блоков if довольно проста. Он анализирует аргумент события getOutputPageNumber(), чтобы опустить некоторые ссылки, где это необходимо: ссылки [First] и [Prev] не будут добавлены на первую страницу, а [Next] и Ссылки [Last] не будут отображаться на последней странице. Логика также предназначена для реализации обоих сценариев, независимо от того, указаны номера страниц или нет.

После блоков if идет код, который добавляет номер страницы в правом нижнем углу страницы.

Последняя строка добавляет запись структуры страницы, которая представляет собой элемент, который будет отображаться в области навигации средства просмотра PDF (если поддерживается).

Код для конвертации

Теперь, когда обработчик события «перед страницей» определен, мы можем написать код для преобразования документа:

// Modify page on conversion event.

// Open an XPS document
try (XpsDocument doc = new XpsDocument(getDataDir() + "Sample3.xps");
     // Create a font
     FileInputStream fontStream = new FileInputStream(getDataDir() + "arialbd.ttf")) {
        
    // Create options for conversion to PDF
    PdfSaveOptions options = new PdfSaveOptions();
    // Set the filter for the pages that need conversion
    options.setPageNumbers(new int[] { 2, 6, 7, 13 });
    // Add the event handler that will execute right before the conversion of each page
    options.getBeforePageSavingEventHandlers().add(new NavigationInjector(doc.createFont(fontStream), options.getPageNumbers()));
    // Save resultant XPS document
    doc.saveAsPdf(getOutputDir() + "ModifyPageOnConversion_out.pdf", options);
}

Мы открываем файл XPS, а затем создаем объект потока с файлом данных шрифта. Затем мы создаем экземпляр класса PdfSaveOptions и указываем номера страниц, которые нам нужно преобразовать. Следующая строка «подключает» обработчик событий «before-page» к заданию преобразования через коллекцию getBeforePageSavingEventHandlers().

Все, что осталось сделать, это запустить преобразование в PDF, используя метод saveAsPdf() документа.

Заключение

В этой статье мы рассмотрели фундаментальные аспекты событийно-ориентированного подхода в программировании, рассмотрели прямой метод изменения страниц документа XPS и изучили более продвинутый метод внесения повторяющихся изменений во все выходные страницы в процессе преобразования. , на примере вставки навигационных гиперссылок.

Полные примеры можно найти в нашем Пример проекта.