com.adobe.pdfservices.operation.pdfjobs.result.pdfproperties.Page Maven / Gradle / Ivy

Go to download

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

Adobe PDF Services SDK allows you to access RESTful APIs to create, convert, and manipulate PDFs within your applications. Older versions can be found under groupId: com.adobe.documentservices, artifactId: pdftools-sdk

There is a newer version: 4.2.0

Show newest version

/*
 * Copyright 2024 Adobe
 * All Rights Reserved.
 *
 * NOTICE: Adobe permits you to use, modify, and distribute this file in
 * accordance with the terms of the Adobe license agreement accompanying
 * it. If you have received this file from a source other than Adobe,
 * then your use, modification, or distribution of it requires the prior
 * written permission of Adobe.
 */
package com.adobe.pdfservices.operation.pdfjobs.result.pdfproperties;

/**
 * This class provides information about a Page of the specified PDF file, such as page number, height, width etc.
 */
public class Page {

    private Integer pageNumber;

    private Boolean isScanned;

    private Double width;

    private Boolean hasStructure;

    private Content content;

    private Double height;

    /**
     * Returns a boolean specifying whether the page is scanned.
     *
     * @return {@code true} if the page is scanned. False otherwise.
     */
    public Boolean isScanned() {
        return isScanned;
    }

    /**
     * Returns a boolean specifying whether the page has structure/tagging.
     *
     * @return {@code true} if the page has structure/tagging. False otherwise.
     */
    public Boolean hasStructure() {
        return hasStructure;
    }

    /**
     * Returns a {@link Content} instance that specifies content level properties of the PDF such as number of
     * images, textual content etc.
     *
     * @return A {@link Content} instance.
     */
    public Content getContent() {
        return content;
    }

    /**
     * Returns the height of the page.
     *
     * @return A Double denoting the height of the page.
     */
    public Double getHeight() {
        return height;
    }

    /**
     * Returns the page number of this {@link Page}, starting from 0.
     *
     * @return An Integer denoting the page number.
     */
    public Integer getPageNumber() {
        return pageNumber;
    }

    /**
     * Returns the width of the page.
     *
     * @return A Double denoting the width of the page.
     */
    public Double getWidth() {
        return width;
    }

    void setPageNumber(Integer pageNumber) {
        this.pageNumber = pageNumber;
    }

    void setScanned(Boolean scanned) {
        isScanned = scanned;
    }

    void setWidth(Double width) {
        this.width = width;
    }

    void setHasStructure(Boolean hasStructure) {
        this.hasStructure = hasStructure;
    }

    void setContent(Content content) {
        this.content = content;
    }

    void setHeight(Double height) {
        this.height = height;
    }
}