PdfAnnotationAdditionalActionsTest.java

/*
    This file is part of the iText (R) project.
    Copyright (c) 1998-2025 Apryse Group NV
    Authors: Apryse Software.

    This program is offered under a commercial and under the AGPL license.
    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.

    AGPL licensing:
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
package com.itextpdf.kernel.pdf.action;

import com.itextpdf.kernel.pdf.PdfDictionary;
import com.itextpdf.kernel.pdf.PdfName;
import com.itextpdf.test.ExtendedITextTest;

import java.util.List;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.Tag;

@Tag("UnitTest")
public class PdfAnnotationAdditionalActionsTest  extends ExtendedITextTest {

    @Test
    public void onEnterTest() {
        PdfAnnotationAdditionalActions aa = new PdfAnnotationAdditionalActions(new PdfDictionary());
        PdfAction action = PdfAction.createHide("test", false);
        aa.setOnEnter(action);

        Assertions.assertEquals(action.getPdfObject().getAsString(PdfName.T), aa.getOnEnter().getPdfObject().getAsString(PdfName.T));
    }

    @Test
    public void onExitTest() {
        PdfAnnotationAdditionalActions aa = new PdfAnnotationAdditionalActions(new PdfDictionary());
        PdfAction action = PdfAction.createHide("test", false);
        aa.setOnExit(action);

        Assertions.assertEquals(action.getPdfObject().getAsString(PdfName.T), aa.getOnExit().getPdfObject().getAsString(PdfName.T));
    }

    @Test
    public void onFocusTest() {
        PdfAnnotationAdditionalActions aa = new PdfAnnotationAdditionalActions(new PdfDictionary());
        PdfAction action = PdfAction.createHide("test", false);
        aa.setOnFocus(action);

        Assertions.assertEquals(action.getPdfObject().getAsString(PdfName.T), aa.getOnFocus().getPdfObject().getAsString(PdfName.T));
    }

    @Test
    public void onLostFocusTest() {
        PdfAnnotationAdditionalActions aa = new PdfAnnotationAdditionalActions(new PdfDictionary());
        PdfAction action = PdfAction.createHide("test", false);
        aa.setOnLostFocus(action);

        Assertions.assertEquals(action.getPdfObject().getAsString(PdfName.T), aa.getOnLostFocus().getPdfObject().getAsString(PdfName.T));
    }

    @Test
    public void onMouseDownTest() {
        PdfAnnotationAdditionalActions aa = new PdfAnnotationAdditionalActions(new PdfDictionary());
        PdfAction action = PdfAction.createHide("test", false);
        aa.setOnMouseDown(action);

        Assertions.assertEquals(action.getPdfObject().getAsString(PdfName.T), aa.getOnMouseDown().getPdfObject().getAsString(PdfName.T));
    }

    @Test
    public void onMouseUpTest() {
        PdfAnnotationAdditionalActions aa = new PdfAnnotationAdditionalActions(new PdfDictionary());
        PdfAction action = PdfAction.createHide("test", false);
        aa.setOnMouseUp(action);

        Assertions.assertEquals(action.getPdfObject().getAsString(PdfName.T), aa.getOnMouseUp().getPdfObject().getAsString(PdfName.T));
    }


    @Test
    public void onPageClosedTest() {
        PdfAnnotationAdditionalActions aa = new PdfAnnotationAdditionalActions(new PdfDictionary());
        PdfAction action = PdfAction.createHide("test", false);
        aa.setOnPageClosed(action);

        Assertions.assertEquals(action.getPdfObject().getAsString(PdfName.T), aa.getOnPageClosed().getPdfObject().getAsString(PdfName.T));
    }

    @Test
    public void onPageLostViewTest() {
        PdfAnnotationAdditionalActions aa = new PdfAnnotationAdditionalActions(new PdfDictionary());
        PdfAction action = PdfAction.createHide("test", false);
        aa.setOnPageLostView(action);

        Assertions.assertEquals(action.getPdfObject().getAsString(PdfName.T), aa.getOnPageLostView().getPdfObject().getAsString(PdfName.T));
    }

    @Test
    public void onPageOpenedTest() {
        PdfAnnotationAdditionalActions aa = new PdfAnnotationAdditionalActions(new PdfDictionary());
        PdfAction action = PdfAction.createHide("test", false);
        aa.setOnPageOpened(action);

        Assertions.assertEquals(action.getPdfObject().getAsString(PdfName.T), aa.getOnPageOpened().getPdfObject().getAsString(PdfName.T));
    }

    @Test
    public void onPageVisibleTest() {
        PdfAnnotationAdditionalActions aa = new PdfAnnotationAdditionalActions(new PdfDictionary());
        PdfAction action = PdfAction.createHide("test", false);
        aa.setOnPageVisible(action);

        Assertions.assertEquals(action.getPdfObject().getAsString(PdfName.T), aa.getOnPageVisible().getPdfObject().getAsString(PdfName.T));
    }
    
    @Test
    public void getAllKnownActions() {
        PdfAnnotationAdditionalActions aa = new PdfAnnotationAdditionalActions(new PdfDictionary());
        PdfAction actionPageVisible = PdfAction.createHide("PageVisible", false);
        PdfAction actionPageOpened = PdfAction.createHide("PageOpened", false);
        PdfAction actionPageLostView = PdfAction.createHide("PageLostView", false);
        PdfAction actionPageClosed = PdfAction.createHide("PageClosed", false);
        PdfAction actionMouseUp = PdfAction.createHide("MouseUp", false);
        PdfAction actionMouseDown = PdfAction.createHide("MouseDown", false);
        PdfAction actionLostFocus = PdfAction.createHide("LostFocus", false);
        PdfAction actionFocus = PdfAction.createHide("Focus", false);
        PdfAction actionExit = PdfAction.createHide("Exit", false);
        PdfAction actionEnter = PdfAction.createHide("Enter", false);
        
        aa.setOnPageVisible(actionPageVisible);
        aa.setOnPageClosed(actionPageClosed);
        aa.setOnPageOpened(actionPageOpened);
        aa.setOnPageLostView(actionPageLostView);
        aa.setOnExit(actionExit);
        aa.setOnEnter(actionEnter);
        aa.setOnMouseUp(actionMouseUp);
        aa.setOnMouseDown(actionMouseDown);
        aa.setOnFocus(actionFocus);
        aa.setOnLostFocus(actionLostFocus);

        List<PdfAction> result = aa.getAllKnownActions();
        Assertions.assertEquals(10, result.size());
        
        Assertions.assertTrue(result.stream().
                anyMatch((PdfAction a) -> a.getPdfObject().getAsString(PdfName.T).getValue() == "PageVisible"));
        Assertions.assertTrue(result.stream().
                anyMatch((PdfAction a) -> a.getPdfObject().getAsString(PdfName.T).getValue() == "PageClosed"));
        Assertions.assertTrue(result.stream().
                anyMatch((PdfAction a) -> a.getPdfObject().getAsString(PdfName.T).getValue() == "PageOpened"));
        Assertions.assertTrue(result.stream().
                anyMatch((PdfAction a) -> a.getPdfObject().getAsString(PdfName.T).getValue() == "PageLostView"));
        Assertions.assertTrue(result.stream().
                anyMatch((PdfAction a) -> a.getPdfObject().getAsString(PdfName.T).getValue() == "Exit"));
        Assertions.assertTrue(result.stream().
                anyMatch((PdfAction a) -> a.getPdfObject().getAsString(PdfName.T).getValue() == "Enter"));
        Assertions.assertTrue(result.stream().
                anyMatch((PdfAction a) -> a.getPdfObject().getAsString(PdfName.T).getValue() == "MouseUp"));
        Assertions.assertTrue(result.stream().
                anyMatch((PdfAction a) -> a.getPdfObject().getAsString(PdfName.T).getValue() == "MouseDown"));
        Assertions.assertTrue(result.stream().
                anyMatch((PdfAction a) -> a.getPdfObject().getAsString(PdfName.T).getValue() == "Focus"));
        Assertions.assertTrue(result.stream().
                anyMatch((PdfAction a) -> a.getPdfObject().getAsString(PdfName.T).getValue() == "LostFocus"));
    }

}