com.itextpdf.text.pdf.PdfVisibilityExpression Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of itextpdf Show documentation
iText, a free Java-PDF library
There is a newer version: 5.5.13.4
/*
 * $Id: PdfLayerMembership.java 4242 2010-01-02 23:22:20Z xlv $
 *
 * This file is part of the iText (R) project.
 * Copyright (c) 1998-2012 1T3XT BVBA
 * 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 1T3XT,
 * 1T3XT 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;

import com.itextpdf.text.error_messages.MessageLocalization;

/**
 * An array specifying a visibility expression, used to compute visibility
 * of content based on a set of optional content groups.
 * @since 5.0.2
 */
public class PdfVisibilityExpression extends PdfArray {

	/** A boolean operator. */
	public static final int OR = 0;
	/** A boolean operator. */
	public static final int AND = 1;
	/** A boolean operator. */
	public static final int NOT = -1;
	
	/**
	 * Creates a visibility expression.
	 * @param type should be AND, OR, or NOT
	 */
	public PdfVisibilityExpression(int type) {
		super();
		switch(type) {
		case OR:
			super.add(PdfName.OR);
			break;
		case AND:
			super.add(PdfName.AND);
			break;
		case NOT:
			super.add(PdfName.NOT);
			break;
		default:
			throw new IllegalArgumentException(MessageLocalization.getComposedMessage("illegal.ve.value"));	
		} 
	}

	/**
	 * @see com.itextpdf.text.pdf.PdfArray#add(int, com.itextpdf.text.pdf.PdfObject)
	 */
	@Override
	public void add(int index, PdfObject element) {
		throw new IllegalArgumentException(MessageLocalization.getComposedMessage("illegal.ve.value"));
	}

	/**
	 * @see com.itextpdf.text.pdf.PdfArray#add(com.itextpdf.text.pdf.PdfObject)
	 */
	@Override
	public boolean add(PdfObject object) {
		if (object instanceof PdfLayer)
			return super.add(((PdfLayer)object).getRef());
		if (object instanceof PdfVisibilityExpression)
			return super.add(object);
		throw new IllegalArgumentException(MessageLocalization.getComposedMessage("illegal.ve.value"));
	}

	/**
	 * @see com.itextpdf.text.pdf.PdfArray#addFirst(com.itextpdf.text.pdf.PdfObject)
	 */
	@Override
	public void addFirst(PdfObject object) {
		throw new IllegalArgumentException(MessageLocalization.getComposedMessage("illegal.ve.value"));
	}

	/**
	 * @see com.itextpdf.text.pdf.PdfArray#add(float[])
	 */
	@Override
	public boolean add(float[] values) {
		throw new IllegalArgumentException(MessageLocalization.getComposedMessage("illegal.ve.value"));
	}

	/**
	 * @see com.itextpdf.text.pdf.PdfArray#add(int[])
	 */
	@Override
	public boolean add(int[] values) {
		throw new IllegalArgumentException(MessageLocalization.getComposedMessage("illegal.ve.value"));
	}
	
}