com.pdftools.pdf2image.FaxImageOptions 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.
There is a newer version: 1.8.0
Show newest version
/****************************************************************************
 *
 * File:            FaxImageOptions.java
 *
 * Description:     PDFTOOLS FaxImageOptions Class
 *
 * 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;

import com.pdftools.sys.*;
import com.pdftools.internal.*;
import java.util.EnumSet;
import java.time.OffsetDateTime;
/**
 * The settings for TIFF Fax output images
 * Create a black-and-white (bitonal) TIFF Fax output image.
 * For the output file name, it is recommended to use the file extension ".tif".
 */
public class FaxImageOptions extends com.pdftools.pdf2image.ImageOptions 
{
    protected FaxImageOptions(long handle) 
    {
        super(handle);
    }

    /**
     * @hidden
     */
    public static FaxImageOptions createDynamicObject(long handle)
    {
        return new FaxImageOptions(handle);
    }




     /**
     * The vertical image resolution (Getter)
     * 
     * This property allows a choice of which vertical
     * resolution to use.
     * For details, see {@link FaxVerticalResolution }.
     * 
     * Note that the horizontal resolution is fixed at 204 DPI by the
     * Fax standard.
     * 
     * Default: {@link FaxVerticalResolution#STANDARD }
     */
    public com.pdftools.pdf2image.FaxVerticalResolution getVerticalResolution()
    {
        int retVal = getVerticalResolutionNative(getHandle());
        if (retVal == 0)
        {
            switch (getLastErrorCode())
            {
                case 0: break;
                default: throwLastRuntimeException();
            }
        }
        return com.pdftools.pdf2image.FaxVerticalResolution.fromValue(retVal);
    }

     /**
     * The vertical image resolution (Setter)
     * 
     * This property allows a choice of which vertical
     * resolution to use.
     * For details, see {@link FaxVerticalResolution }.
     * 
     * Note that the horizontal resolution is fixed at 204 DPI by the
     * Fax standard.
     * 
     * Default: {@link FaxVerticalResolution#STANDARD }
     * @throws IllegalArgumentException if {@code value} is {@code null}
     */
    public void setVerticalResolution(com.pdftools.pdf2image.FaxVerticalResolution value)
    {
        if (value == null)
            throw new IllegalArgumentException("Argument 'value' must not be null.", new NullPointerException("'value'"));
        boolean retVal = setVerticalResolutionNative(getHandle(), value.getValue());
        if (!retVal) 
        {
            switch (getLastErrorCode())
            {
                case 0: throw new RuntimeException("An unexpected error occurred");
                default: throwLastRuntimeException();
            }
        }
    }


     /**
     * The Fax compression algorithm (Getter)
     * 
     * This property allows a choice of which compression
     * type to use.
     * For details, see {@link TiffBitonalCompressionType }.
     * 
     * Default: {@link TiffBitonalCompressionType#G3 }
     */
    public com.pdftools.pdf2image.TiffBitonalCompressionType getCompression()
    {
        int retVal = getCompressionNative(getHandle());
        if (retVal == 0)
        {
            switch (getLastErrorCode())
            {
                case 0: break;
                default: throwLastRuntimeException();
            }
        }
        return com.pdftools.pdf2image.TiffBitonalCompressionType.fromValue(retVal);
    }

     /**
     * The Fax compression algorithm (Setter)
     * 
     * This property allows a choice of which compression
     * type to use.
     * For details, see {@link TiffBitonalCompressionType }.
     * 
     * Default: {@link TiffBitonalCompressionType#G3 }
     * @throws IllegalArgumentException if {@code value} is {@code null}
     */
    public void setCompression(com.pdftools.pdf2image.TiffBitonalCompressionType value)
    {
        if (value == null)
            throw new IllegalArgumentException("Argument 'value' must not be null.", new NullPointerException("'value'"));
        boolean retVal = setCompressionNative(getHandle(), value.getValue());
        if (!retVal) 
        {
            switch (getLastErrorCode())
            {
                case 0: throw new RuntimeException("An unexpected error occurred");
                default: throwLastRuntimeException();
            }
        }
    }




    private native int getVerticalResolutionNative(long handle);
    private native boolean setVerticalResolutionNative(long handle, int value);
    private native int getCompressionNative(long handle);
    private native boolean setCompressionNative(long handle, int value);

}