com.itextpdf.kernel.pdf.collection.PdfCollectionField Maven / Gradle / Ivy
/*
This file is part of the iText (R) project.
Copyright (c) 1998-2024 Apryse Group NV
Authors: Apryse Software.
This program is offered under a commercial and under the AGPL license.
For commercial licensing, contact us at https://itextpdf.com/sales. For AGPL licensing, see below.
AGPL licensing:
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
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 {
/**
* A possible type of collection field.
*/
public static final int TEXT = 0;
/**
* A possible type of collection field.
*/
public static final int DATE = 1;
/**
* A possible type of collection field.
*/
public static final int NUMBER = 2;
/**
* A possible type of collection field.
*/
public static final int FILENAME = 3;
/**
* A possible type of collection field.
*/
public static final int DESC = 4;
/**
* A possible type of collection field.
*/
public static final int MODDATE = 5;
/**
* A possible type of collection field.
*/
public static final int CREATIONDATE = 6;
/**
* A possible type of collection field.
*/
public static final int SIZE = 7;
protected int subType;
protected PdfCollectionField(PdfDictionary pdfObject) {
super(pdfObject);
String subType = pdfObject.getAsName(PdfName.Subtype).getValue();
switch (subType) {
case "D":
this.subType = DATE;
break;
case "N":
this.subType = NUMBER;
break;
case "F":
this.subType = FILENAME;
break;
case "Desc":
this.subType = DESC;
break;
case "ModDate":
this.subType = MODDATE;
break;
case "CreationDate":
this.subType = CREATIONDATE;
break;
case "Size":
this.subType = SIZE;
break;
default:
this.subType = TEXT;
break;
}
}
/**
* Creates a PdfCollectionField.
*
* @param name the field name
* @param subType the field subtype
*/
public PdfCollectionField(String name, int subType) {
super(new PdfDictionary());
getPdfObject().put(PdfName.N, new PdfString(name));
this.subType = subType;
switch (subType) {
default:
getPdfObject().put(PdfName.Subtype, PdfName.S);
break;
case DATE:
getPdfObject().put(PdfName.Subtype, PdfName.D);
break;
case NUMBER:
getPdfObject().put(PdfName.Subtype, PdfName.N);
break;
case FILENAME:
getPdfObject().put(PdfName.Subtype, PdfName.F);
break;
case DESC:
getPdfObject().put(PdfName.Subtype, PdfName.Desc);
break;
case MODDATE:
getPdfObject().put(PdfName.Subtype, PdfName.ModDate);
break;
case CREATIONDATE:
getPdfObject().put(PdfName.Subtype, PdfName.CreationDate);
break;
case SIZE:
getPdfObject().put(PdfName.Subtype, PdfName.Size);
break;
}
}
/**
* The relative order of the field name. Fields are sorted in ascending order.
*
* @param order a number indicating the order of the field
* @return this instance to support fluent interface
*/
public PdfCollectionField setOrder(int order) {
getPdfObject().put(PdfName.O, new PdfNumber(order));
return this;
}
/**
* Retrieves the order of the field name.
*
* @return the {@link PdfNumber PDF number} showing the order of the field name
*/
public PdfNumber getOrder() {
return getPdfObject().getAsNumber(PdfName.O);
}
/**
* Sets the initial visibility of the field.
*
* @param visible is a state of visibility
* @return this instance to support fluent interface
*/
public PdfCollectionField setVisibility(boolean visible) {
getPdfObject().put(PdfName.V, PdfBoolean.valueOf(visible));
return this;
}
/**
* Retrieves the initial visibility of the field.
*
* @return the initial visibility of the field as {@link PdfBoolean PDF boolean} value
*/
public PdfBoolean getVisibility() {
return getPdfObject().getAsBoolean(PdfName.V);
}
/**
* Indication if the field value should be editable in the viewer.
*
* @param editable is a state of editable
* @return this instance to support fluent interface
*/
public PdfCollectionField setEditable(boolean editable) {
getPdfObject().put(PdfName.E, PdfBoolean.valueOf(editable));
return this;
}
/**
* Retrieves the state of the editable of the field.
*
* @return true if filed is editable and false otherwise. Returned value is presented
* as {@link PdfBoolean pdf boolean}.
*/
public PdfBoolean getEditable() {
return getPdfObject().getAsBoolean(PdfName.E);
}
/**
* Converts string to appropriate pdf value.
*
* @param value is a plain string representation of the value
* @return resulting {@link PdfObject PDF object}
*/
public PdfObject getValue(String value) {
switch (subType) {
case TEXT:
return new PdfString(value);
case DATE:
return new PdfDate(PdfDate.decode(value)).getPdfObject();
case NUMBER:
return new PdfNumber(Double.parseDouble(value.trim()));
}
throw new PdfException(KernelExceptionMessageConstant.UNACCEPTABLE_FIELD_VALUE)
.setMessageParams(value, getPdfObject().getAsString(PdfName.N).getValue());
}
@Override
protected boolean isWrappedObjectMustBeIndirect() {
return false;
}
}