org.icepdf.ri.common.MyAnnotationCallback Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of icepdf-viewer Show documentation
ICEpdf Java Swing/AWT reference implementation.
The newest version!
/*
 * Copyright 2006-2019 ICEsoft Technologies Canada Corp.
 *
 * 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.
 */
package org.icepdf.ri.common;

import org.icepdf.core.pobjects.*;
import org.icepdf.core.pobjects.actions.*;
import org.icepdf.core.pobjects.annotations.Annotation;
import org.icepdf.core.pobjects.annotations.LinkAnnotation;
import org.icepdf.core.pobjects.annotations.MarkupAnnotation;
import org.icepdf.ri.common.views.*;
import org.icepdf.ri.common.views.annotations.AbstractAnnotationComponent;
import org.icepdf.ri.common.views.annotations.MarkupAnnotationComponent;
import org.icepdf.ri.common.views.annotations.PopupAnnotationComponent;
import org.icepdf.ri.util.BareBonesBrowserLaunch;

import java.io.File;
import java.util.ArrayList;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * This class represents a basic implementation of the AnnotationCallback
 * @since 2.6
 */
public class MyAnnotationCallback implements AnnotationCallback {

    private static final Logger logger =
            Logger.getLogger(MyAnnotationCallback.class.toString());

    private final DocumentViewController documentViewController;


    public MyAnnotationCallback(DocumentViewController documentViewController) {
        this.documentViewController = documentViewController;
    }

    /**
     * Implemented Annotation Callback method.  When an annotation is
     * activated in a PageViewComponent it passes the annotation to this method
     * for processing.  The PageViewComponent take care of drawing the
     * annotation states but it up to this method to process the
     * annotation.
     *
     * @param annotation annotation that was activated by a user via the
     *                   PageViewComponent.
     * @param action     the action event that was fired when the annotation was clicked.  This can be
     *                   the A or AA entry.
     * @param x          x-coordinate of input device click that initiated the annotation action.
     * @param y          y-coordinate of input device click that initiated the annotation action.
     */
    public void processAnnotationAction(Annotation annotation, Action action, int x, int y) {
        if (logger.isLoggable(Level.FINE)) {
            logger.fine("Annotation " + annotation.toString());
            if (annotation.getAction() != null) {
                logger.fine("   Action: " + annotation.getAction().toString());
            }
        }

        if (annotation instanceof LinkAnnotation) {
            LinkAnnotation linkAnnotation = (LinkAnnotation) annotation;
            // look for an A entry,
            if (action != null) {
                // do instance of check to process actions correctly.
                if (action instanceof GoToAction &&
                        documentViewController != null) {
                    documentViewController.setDestinationTarget(
                            ((GoToAction) action).getDestination());
                } else if (action instanceof URIAction) {
                    BareBonesBrowserLaunch.openURL(
                            ((URIAction) action).getURI());
                } else if (action instanceof GoToRAction) {
                    // process resource request
                } else if (action instanceof LaunchAction) {
                    LaunchAction launchAction = (LaunchAction) action;
                    String file = launchAction.getExternalFile();
                    String location =
                            documentViewController.getDocument().getDocumentLocation();
                    location = location.substring(0, location.lastIndexOf(File.separator) + 1);
                    BareBonesBrowserLaunch.openFile(location + file);
                }

            }
            // look for a Dest entry, only present if an action is not found
            // or vise versa.
            else if (linkAnnotation.getDestination() != null &&
                    documentViewController != null) {
                // use this controller to navigate to the correct page
                documentViewController.setDestinationTarget(
                        linkAnnotation.getDestination());
            }

        }
        // catch any other annotation types and try and process their action.
        else {
            // look for the dest entry and navigate to it.
            if (action != null) {
                if (action instanceof GoToAction) {
                    documentViewController.setDestinationTarget(
                            ((GoToAction) action).getDestination());
                } else if (action instanceof URIAction) {
                    BareBonesBrowserLaunch.openURL(
                            ((URIAction) action).getURI());
                } else if (action instanceof SubmitFormAction) {
                    // submits form data following the submit actions.
                    int responseCode = ((SubmitFormAction) action).executeFormAction(x, y);
                } else if (action instanceof ResetFormAction) {
                    // resets the form data following reset action.
                    int responseCode = ((ResetFormAction) action).executeFormAction(x, y);
                } else if (action instanceof JavaScriptAction) {
                    // resets the form dat following reset actions properties
                    JavaScriptAction javaScriptAction = (JavaScriptAction) action;
                    if (logger.isLoggable(Level.FINE)) {
                        logger.fine("Annotation JS: " + javaScriptAction.getJavaScript());
                    }
                } else if (action instanceof NamedAction) {
                    // Named actions are key words that we should act on.
                    NamedAction namedAction = (NamedAction) action;
                    Name actionName = namedAction.getNamedAction();
                    // go to the first page of the document.
                    if (NamedAction.FIRST_PAGE_KEY.equals(actionName)) {
                        documentViewController.setCurrentPageIndex(0);
                    } // go to the last page of the document.
                    else if (NamedAction.LAST_PAGE_KEY.equals(actionName)) {
                        int numberOfPages = documentViewController.getDocument().getNumberOfPages();
                        documentViewController.setCurrentPageIndex(numberOfPages - 1);
                    } // next page.
                    else if (NamedAction.NEXT_PAGE_KEY.equals(actionName)) {
                        int currentPageNumber = documentViewController.getCurrentPageIndex();
                        documentViewController.setCurrentPageIndex(currentPageNumber + 1);
                    } // previous page.
                    else if (NamedAction.PREV_PAGE_KEY.equals(actionName)) {
                        int currentPageNumber = documentViewController.getCurrentPageIndex();
                        documentViewController.setCurrentPageIndex(currentPageNumber - 1);
                    } // print the current document.
                    else if (NamedAction.PRINT_KEY.equals(actionName)) {
                        Controller controller = documentViewController.getParentController();
                        controller.print(true);
                    } // show save as dialog.
                    else if (NamedAction.SAVE_AS_KEY.equals(actionName)) {
                        Controller controller = documentViewController.getParentController();
                        controller.saveFileAs();
                    }
                }
            }
        }
    }

    /**
     * Implemented Annotation Callback method.  This method is called when a
     * pages annotations been initialized but before the page has been painted.
     * This method blocks the 
     *
     * @param page page that has been initialized.  The pages annotations are
     *             available via an accessor method.
     */
    public void pageAnnotationsInitialized(Page page) {

    }

    /**
     * New annotation created with view tool.
     *
     * @param pageComponent       page that annotation was added to.
     * @param annotationComponent component that will be created.
     */
    public void newAnnotation(PageViewComponent pageComponent,
                              AnnotationComponent annotationComponent) {
        // do a bunch a work to get at the page object.
        Document document = documentViewController.getDocument();
        PageTree pageTree = document.getPageTree();
        Page page = pageTree.getPage(pageComponent.getPageIndex());
        page.addAnnotation(annotationComponent.getAnnotation(), !annotationComponent.isSynthetic());

        // no we have let the pageComponent now about it.
        ((PageViewComponentImpl) pageComponent).addAnnotation(annotationComponent);

//        // finally change the current tool to the annotation selection
//        documentViewController.getParentController().setDocumentToolMode(
//                DocumentViewModel.DISPLAY_TOOL_SELECTION);
    }

    /**
     * Update the annotation and ready state for save.
     *
     * @param annotationComponent annotation component to be added to page.
     */
    public void updateAnnotation(AnnotationComponent annotationComponent) {
        Document document = documentViewController.getDocument();
        PageTree pageTree = document.getPageTree();
        Page page = pageTree.getPage(annotationComponent.getPageIndex());
        page.updateAnnotation(annotationComponent.getAnnotation());
    }

    /**
     * Remove the annotation and ready state for save.
     *
     * @param annotationComponent annotation component to be added to page.
     */
    public void removeAnnotation(PageViewComponent pageComponent,
                                 AnnotationComponent annotationComponent) {
        // remove annotation
        Document document = documentViewController.getDocument();
        PageTree pageTree = document.getPageTree();
        Page page = pageTree.getPage(pageComponent.getPageIndex());
        // remove from page
        page.deleteAnnotation(annotationComponent.getAnnotation());
        // remove from page view.
        ((PageViewComponentImpl) pageComponent).removeAnnotation(annotationComponent);
        // check to see if there is an associated popup
        if (annotationComponent.getAnnotation() instanceof MarkupAnnotation) {
            MarkupAnnotation markupAnnotation =
                    (MarkupAnnotation) annotationComponent.getAnnotation();
            if (markupAnnotation.getPopupAnnotation() != null) {
                page.deleteAnnotation(markupAnnotation.getPopupAnnotation());
                // find and remove the popup component
                final AnnotationComponent component =
                        ((MarkupAnnotationComponent) annotationComponent).getPopupAnnotationComponent();
                if (component != null) {
                    ((PageViewComponentImpl) pageComponent).removeAnnotation(component);
                }
            }
        }

    }
}