com.pdftools.pdf2image.AnnotationOptions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pdftools-sdk Show documentation

The Pdftools SDK is a comprehensive development library that lets developers integrate advanced PDF functionalities into in-house applications.

The newest version!

/****************************************************************************
 *
 * File:            AnnotationOptions.java
 *
 * Description:     AnnotationOptions Enumeration
 *
 * Author:          PDF Tools AG
 * 
 * Copyright:       Copyright (C) 2023 - 2024 PDF Tools AG, Switzerland
 *                  All rights reserved.
 * 
 * Notice:          By downloading and using this artifact, you accept PDF Tools AG's
 *                  [license agreement](https://www.pdf-tools.com/license-agreement/),
 *                  [privacy policy](https://www.pdf-tools.com/privacy-policy/),
 *                  and allow PDF Tools AG to track your usage data.
 *
 ***************************************************************************/

package com.pdftools.pdf2image;

/**
 * Defines how to render annotations and their popups
 * 
 * Annotations associate an object such as a sticky note, link or rich media
 * with a location on a PDF page; they may also provide user interaction
 * by means of the mouse and keyboard.
 * 
 * Some annotations have an associated popup.
 * 
 */
public enum AnnotationOptions  
{
    /**
     * Render the annotation without the associated popup
     */
    SHOW_ANNOTATIONS(1),
    /**
     * Render the annotation and the associated popup
     */
    SHOW_ANNOTATIONS_AND_POPUPS(2);

    AnnotationOptions(int value) 
    {
        this.value = value;
    }

    /**
     * @hidden
     */
    public static AnnotationOptions fromValue(int value) 
    {
        switch (value) 
        {
            case 1: return SHOW_ANNOTATIONS;
            case 2: return SHOW_ANNOTATIONS_AND_POPUPS;
        }
        throw new IllegalArgumentException("Unknown value for AnnotationOptions: " + value);
    }

    /**
     * @hidden
     */
    public int getValue() 
    {
        return value;
    }

    private int value;
}