de.erichseifert.vectorgraphics2d.pdf.Page Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of VectorGraphics2D Show documentation
A library for adding vector export to Java(R) Graphics2D.
The newest version!
/*
 * VectorGraphics2D: Vector export for Java(R) Graphics2D
 *
 * (C) Copyright 2010-2017 Erich Seifert ,
 * Michael Seifert 
 *
 * This file is part of VectorGraphics2D.
 *
 * VectorGraphics2D is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * VectorGraphics2D 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with VectorGraphics2D.  If not, see .
 */
package de.erichseifert.vectorgraphics2d.pdf;

import java.awt.geom.Rectangle2D;

/**
 * Represents a page of a PDF document.
 */
class Page implements PDFObject {
	private final Resources resources;
	private final Rectangle2D mediaBox;
	private final DefaultPDFObject contents;
	private PageTreeNode parent;

	/**
	 * Initializes a {@code Page} with the specified parent node, MediaBox and contents.
	 * @param resources Page resources
	 * @param mediaBox Boundaries of the page.
	 * @param contents Contents of the page.
	 */
	public Page(Resources resources, Rectangle2D mediaBox, DefaultPDFObject contents) {
		this.resources = resources;
		this.mediaBox = mediaBox;
		this.contents = contents;
	}

	/**
	 * Returns the type of this object.
	 * The return value is always {@literal Page}.
	 * @return The String {@literal Page}.
	 */
	public String getType() {
		return "Page";
	}

	public Rectangle2D getMediaBox() {
		return mediaBox;
	}

	/**
	 * Returns the immediate parent of this {@code Page}.
	 * @return Parent node.
	 */
	public PageTreeNode getParent() {
		return parent;
	}

	/**
	 * Sets the parent of this {@code Page} to the specified node.
	 * @param parent Immediate parent.
	 */
	protected void setParent(PageTreeNode parent) {
		this.parent = parent;
	}

	/**
	 * Returns the {@code Resources} object associated with this {@code Page}.
	 * @return Page resources.
	 */
	public Resources getResources() {
		return resources;
	}

	/**
	 * Returns the contents of this {@code Page}.
	 * @return Page contents.
	 */
	public DefaultPDFObject getContents() {
		return contents;
	}
}