com.itextpdf.text.pdf.spatial.units.Fraction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of itext-xtra Show documentation
iText Xtra, part of iText a Free Java-PDF library
There is a newer version: 5.5.13.4
/*
 * $Id: 1ab7fedf47969066b2af25d9d2a8df346826298d $
 *
 * This file is part of the iText (R) project.
 * Copyright (c) 1998-2015 iText Group NV
 * Authors: Bruno Lowagie, Balder Van Camp, et al.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License version 3
 * as published by the Free Software Foundation with the addition of the
 * following permission added to Section 15 as permitted in Section 7(a):
 * FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
 * ITEXT GROUP. ITEXT GROUP DISCLAIMS THE WARRANTY OF NON INFRINGEMENT
 * OF THIRD PARTY RIGHTS
 *
 * This program 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 Affero General Public License for more details.
 * You should have received a copy of the GNU Affero General Public License
 * along with this program; if not, see http://www.gnu.org/licenses or write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA, 02110-1301 USA, or download the license from the following URL:
 * http://itextpdf.com/terms-of-use/
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License,
 * a covered work must retain the producer line in every PDF that is created
 * or manipulated using iText.
 *
 * You can be released from the requirements of the license by purchasing
 * a commercial license. Buying such a license is mandatory as soon as you
 * develop commercial activities involving the iText software without
 * disclosing the source code of your own applications.
 * These activities include: offering paid services to customers as an ASP,
 * serving PDFs on the fly in a web application, shipping iText with a closed
 * source product.
 *
 * For more information, please contact iText Software Corp. at this
 * address: [email protected]
 */
package com.itextpdf.text.pdf.spatial.units;

import com.itextpdf.text.pdf.PdfName;

/**
 * Indicates whether and in what manner to display a fractional value
 * from the result of converting to the units
 * @since 5.1.0
 */
public enum Fraction {
	/**
	 * Show as decimal to the precision specified by D
	 */
	DECIMAL("D"),
	/**
	 * Show as a fraction with denominator specified by D
	 */
	FRACTION("F"),
	/**
	 * No fractional part; round to the nearest whole unit.
	 */
	ROUND("R"),
	/**
	 * No fractional part; truncate to achieve whole units.
	 */
	TRUNCATE("T");

	/** The name used for the Fraction. */
	private String name;

	/** Creates a Fraction type. */
	private Fraction(String name) {
		this.name = name;
	}

	/** Gets the PdfName. */
	public PdfName getPdfName() {
		return new PdfName(name);
	}
}