com.itextpdf.text.pdf.richmedia.RichMediaWindow 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
The newest version!
/*
 *
 * This file is part of the iText (R) project.
    Copyright (c) 1998-2022 iText Group NV
 * Authors: Bruno Lowagie, Paulo Soares, 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.richmedia;

import com.itextpdf.text.pdf.PdfDictionary;
import com.itextpdf.text.pdf.PdfName;
import com.itextpdf.text.pdf.PdfNumber;

/**
 * The RichMediaWindow dictionary stores the dimensions and position of the
 * floating window presented to the user. It is used only if Style is set
 * to Windowed.
 * See ExtensionLevel 3 p84
 * @see	RichMediaPresentation
 * @since	5.0.0
 */
public class RichMediaWindow extends PdfDictionary {

	/**
	 * Creates a RichMediaWindow dictionary.
	 */
	public RichMediaWindow() {
		super(PdfName.RICHMEDIAWINDOW);
	}
	
	/**
	 * Sets a dictionary with keys Default, Max, and Min describing values for
	 * the width of the Window in default user space units.
	 * @param	defaultWidth	the default width
	 * @param	maxWidth		the maximum width
	 * @param	minWidth		the minimum width
	 */
	public void setWidth(float defaultWidth, float maxWidth, float minWidth) {
		put(PdfName.WIDTH, createDimensionDictionary(defaultWidth, maxWidth, minWidth));
	}

	/**
	 * Sets a dictionary with keys Default, Max, and Min describing values for
	 * the height of the Window in default user space units.
	 * @param	defaultHeight	the default height
	 * @param	maxHeight		the maximum height
	 * @param	minHeight		the minimum height
	 */
	public void setHeight(float defaultHeight, float maxHeight, float minHeight) {
		put(PdfName.HEIGHT, createDimensionDictionary(defaultHeight, maxHeight, minHeight));
	}
	
	/**
	 * Creates a dictionary that can be used for the HEIGHT and WIDTH entries
	 * of the RichMediaWindow dictionary.
	 * @param	d		the default
	 * @param	max		the maximum
	 * @param	min		the minimum
	 */
	private PdfDictionary createDimensionDictionary(float d, float max, float min) {
		PdfDictionary dict = new PdfDictionary();
		dict.put(PdfName.DEFAULT, new PdfNumber(d));
		dict.put(PdfName.MAX_CAMEL_CASE, new PdfNumber(max));
		dict.put(PdfName.MIN_CAMEL_CASE, new PdfNumber(min));
		return dict;
	}
	
	/**
	 * Sets a RichMediaPosition dictionary describing the position of the RichMediaWindow.
	 * @param	position	a RichMediaPosition object
	 */
	public void setPosition(RichMediaPosition position) {
		put(PdfName.POSITION, position);
	}
}