com.itextpdf.tool.xml.css.CssFile Maven / Gradle / Ivy

/*
 * $Id: bee4c25608a1e8acc8c0559b096701e4842929d8 $
 *
 * This file is part of the iText (R) project.
 * Copyright (c) 1998-2016 iText Group NV
 * Authors: Balder Van Camp, Emiel Ackermann, 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.tool.xml.css;

import com.itextpdf.tool.xml.Tag;

import java.util.List;
import java.util.Map;

/**
 * Represents a CSS file.
 * @author redlab_b
 *
 */
public interface CssFile {

	/**
	 * Add CSS to this CssFile.
	 * @param selector the CSS selector
	 * @param props the properties for the given selector
	 */
	boolean add(String selector, Map props);

	/**
	 * Return CSS declarations for the given tag.
	 * @param t the tag for searching rules
	 * @return a list of maps with all CSS properties for this tag or an empty list
	 *         if none found.
	 */
	List get(Tag t);

	/**
	 * @return if this CSS file should never be thrown away. Used in CSSFilesImpl#clear
	 */
	boolean isPersistent();

	/**
	 * Indicates that this file should be kept.
	 * @param b true if this file should be kept.
	 */
	void isPersistent(boolean b);

}