com.itextpdf.text.pdf.richmedia.RichMediaDeactivation Maven / Gradle / Ivy

/*
 * $Id: 69e4e68d7d552ad8777144cf9ac0854e21b596d4 $
 *
 * This file is part of the iText (R) project.
 * Copyright (c) 1998-2016 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;

/**
 * The RichMediaActivation dictionary specifies the condition
 * that causes deactivation of the annotation.
 * See ExtensionLevel 3 p80
 * @since	5.0.0
 */
public class RichMediaDeactivation extends PdfDictionary {
	
	/**
	 * Creates a RichMediaActivation dictionary.
	 */
	public RichMediaDeactivation() {
		super(PdfName.RICHMEDIADEACTIVATION);
	}
	
	/**
	 * Sets the activation condition.
	 * Set it to XD, and the annotation is explicitly deactivated by a user action
	 * or script.
	 * To PC, and the annotation is deactivated as soon as the page that contains
	 * the annotation loses focus as the current page.
	 * To PI, abd the annotation is deactivated as soon as the entire page that
	 * contains the annotation is no longer visible.
	 * @param	condition	possible values are:
	 * 		PdfName.XD, PdfName.PC, or PdfName.PI
	 */
	public void setCondition(PdfName condition) {
		put(PdfName.CONDITION, condition);
	}
}