com.itextpdf.kernel.pdf.collection.PdfCollectionItem Maven / Gradle / Ivy
/*
This file is part of the iText (R) project.
Copyright (c) 1998-2023 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.kernel.pdf.collection;
import com.itextpdf.kernel.exceptions.PdfException;
import com.itextpdf.kernel.exceptions.KernelExceptionMessageConstant;
import com.itextpdf.kernel.pdf.PdfDate;
import com.itextpdf.kernel.pdf.PdfDictionary;
import com.itextpdf.kernel.pdf.PdfName;
import com.itextpdf.kernel.pdf.PdfNumber;
import com.itextpdf.kernel.pdf.PdfObject;
import com.itextpdf.kernel.pdf.PdfObjectWrapper;
import com.itextpdf.kernel.pdf.PdfString;
public class PdfCollectionItem extends PdfObjectWrapper {
private PdfCollectionSchema schema;
public PdfCollectionItem(PdfCollectionSchema schema) {
super(new PdfDictionary());
this.schema = schema;
}
/**
* Sets the value of the collection item.
*
* @param key is a key with which the specified value is to be associated
* @param value is a value to be associated with the specified key
* @return this instance to support fluent interface
*/
public PdfCollectionItem addItem(String key, String value) {
PdfCollectionField field = schema.getField(key);
getPdfObject().put(new PdfName(key), field.getValue(value));
return this;
}
/**
* Sets the date value of the collection item.
*
* @param key is a key with which the specified date value is to be associated
* @param date is a {@link PdfDate PDF date} value to be associated with the specified key
*/
public void addItem(String key, PdfDate date) {
PdfCollectionField field = schema.getField(key);
if (field.subType == PdfCollectionField.DATE) {
getPdfObject().put(new PdfName(key), date.getPdfObject());
}
}
/**
* Sets the number value of the collection item.
*
* @param key is a key with which the specified number value is to be associated
* @param number is a {@link PdfNumber PDF number} value to be associated with the specified key
*/
public void addItem(String key, PdfNumber number) {
PdfCollectionField field = schema.getField(key);
if (field.subType == PdfCollectionField.NUMBER) {
getPdfObject().put(new PdfName(key), number);
}
}
/**
* Adds a prefix for the Collection item.
* You can only use this method after you have set the value of the item.
*
* @param key is a key identifying the Collection item
* @param prefix is a prefix to be added
* @return this instance to support fluent interface
*/
public PdfCollectionItem setPrefix(String key, String prefix) {
PdfName fieldName = new PdfName(key);
PdfObject obj = getPdfObject().get(fieldName);
if (obj == null) {
throw new PdfException(KernelExceptionMessageConstant.YOU_MUST_SET_A_VALUE_BEFORE_ADDING_A_PREFIX);
}
PdfDictionary subItem = new PdfDictionary();
subItem.put(PdfName.D, obj);
subItem.put(PdfName.P, new PdfString(prefix));
getPdfObject().put(fieldName, subItem);
return this;
}
@Override
protected boolean isWrappedObjectMustBeIndirect() {
return false;
}
}