Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
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 .
*/
package com.itextpdf.forms.fields;
import com.itextpdf.io.logs.IoLogMessageConstant;
import com.itextpdf.io.font.PdfEncodings;
import com.itextpdf.commons.utils.MessageFormatUtil;
import com.itextpdf.kernel.pdf.PdfArray;
import com.itextpdf.kernel.pdf.PdfDictionary;
import com.itextpdf.kernel.pdf.PdfDocument;
import com.itextpdf.kernel.pdf.PdfName;
import com.itextpdf.kernel.pdf.PdfNumber;
import com.itextpdf.kernel.pdf.PdfObject;
import com.itextpdf.kernel.pdf.PdfString;
import com.itextpdf.kernel.pdf.annot.PdfWidgetAnnotation;
import java.util.ArrayList;
import java.util.List;
import org.slf4j.LoggerFactory;
import org.slf4j.Logger;
/**
* An AcroForm field type representing any type of choice field. Choice fields
* are to be represented by a viewer as a list box or a combo box.
*/
public class PdfChoiceFormField extends PdfFormField {
/**
* If true, the field is a combo box.
* If false, the field is a list box.
*/
public static final int FF_COMBO = makeFieldFlag(18);
/**
* If true, the combo box shall include an editable text box as well as a drop-down list.
* If false, it shall include only a drop-down list.
* This flag shall be used only if the Combo flag is true.
*/
public static final int FF_EDIT = makeFieldFlag(19);
/**
* If true, the field's option items shall be sorted alphabetically.
* This flag is intended for use by writers, not by readers.
*/
public static final int FF_SORT = makeFieldFlag(20);
/**
* If true, more than one of the field's option items may be selected simultaneously.
* If false, at most one item shall be selected.
*/
public static final int FF_MULTI_SELECT = makeFieldFlag(22);
/**
* If true, text entered in the field shall be spell-checked.
*/
public static final int FF_DO_NOT_SPELL_CHECK = makeFieldFlag(23);
/**
* If true, the new value shall be committed as soon as a selection is made (commonly with the pointing device).
*/
public static final int FF_COMMIT_ON_SEL_CHANGE = makeFieldFlag(27);
/**
* Creates a minimal {@link PdfChoiceFormField}.
*
* @param pdfDocument The {@link PdfDocument} instance.
*/
protected PdfChoiceFormField(PdfDocument pdfDocument) {
super(pdfDocument);
}
/**
* Creates a choice form field as a parent of a {@link PdfWidgetAnnotation}.
*
* @param widget The widget which will be a kid of the {@link PdfChoiceFormField}.
* @param pdfDocument The {@link PdfDocument} instance.
*/
protected PdfChoiceFormField(PdfWidgetAnnotation widget, PdfDocument pdfDocument) {
super(widget, pdfDocument);
}
/**
* Creates a choice form field as a wrapper object around a {@link PdfDictionary}.
* This {@link PdfDictionary} must be an indirect object.
*
* @param pdfObject the dictionary to be wrapped, must have an indirect reference.
*/
protected PdfChoiceFormField(PdfDictionary pdfObject) {
super(pdfObject);
}
/**
* Returns Ch, the form type for choice form fields.
*
* @return the form type, as a {@link PdfName}
*/
@Override
public PdfName getFormType() {
return PdfName.Ch;
}
/**
* Sets the index of the first visible option in a scrollable list.
*
* @param index the index of the first option
*
* @return current {@link PdfChoiceFormField}
*/
public PdfChoiceFormField setTopIndex(int index) {
put(PdfName.TI, new PdfNumber(index));
regenerateField();
return this;
}
/**
* Gets the current index of the first option in a scrollable list.
*
* @return the index of the first option, as a {@link PdfNumber}
*/
public PdfNumber getTopIndex() {
return getPdfObject().getAsNumber(PdfName.TI);
}
/**
* Sets the selected items in the field.
*
* @param indices a sorted array of indices representing selected items in the field
*
* @return current {@link PdfChoiceFormField}
*/
public PdfChoiceFormField setIndices(PdfArray indices) {
put(PdfName.I, indices);
return this;
}
/**
* Highlights the options. If this method is used for Combo box, the first value in input array
* will be the field value.
*
* @param optionValues Array of display values to be highlighted.
*
* @return current {@link PdfChoiceFormField}.
*/
public PdfChoiceFormField setListSelected(String[] optionValues) {
return setListSelected(optionValues, true);
}
/**
* Highlights the options and generates field appearance if needed. If this method is used for Combo box,
* the first value in input array will be the field value
*
* @param optionValues Array of options to be highlighted
* @param generateAppearance if false, appearance won't be regenerated
*
* @return current {@link PdfChoiceFormField}
*/
public PdfChoiceFormField setListSelected(String[] optionValues, boolean generateAppearance) {
if (optionValues.length > 1 && !isMultiSelect()) {
Logger logger = LoggerFactory.getLogger(this.getClass());
logger.warn(IoLogMessageConstant.MULTIPLE_VALUES_ON_A_NON_MULTISELECT_FIELD);
}
PdfArray options = getOptions();
PdfArray indices = new PdfArray();
PdfArray values = new PdfArray();
List optionsToUnicodeNames = optionsToUnicodeNames();
for (String element : optionValues) {
if (element == null) {
continue;
}
if (optionsToUnicodeNames.contains(element)) {
int index = optionsToUnicodeNames.indexOf(element);
indices.add(new PdfNumber(index));
PdfObject optByIndex = options.get(index);
values.add(optByIndex.isString() ? (PdfString) optByIndex : (PdfString) ((PdfArray) optByIndex).get(1));
} else {
if (!(this.isCombo() && this.isEdit())) {
Logger logger = LoggerFactory.getLogger(this.getClass());
logger.warn(MessageFormatUtil
.format(IoLogMessageConstant.FIELD_VALUE_IS_NOT_CONTAINED_IN_OPT_ARRAY, element,
this.getFieldName()));
}
values.add(new PdfString(element, PdfEncodings.UNICODE_BIG));
}
}
if (indices.size() > 0) {
setIndices(indices);
} else {
remove(PdfName.I);
}
if (values.size() == 1) {
put(PdfName.V, values.get(0));
} else {
put(PdfName.V, values);
}
if (generateAppearance) {
regenerateField();
}
return this;
}
/**
* Highlights the options. If this method is used for Combo box, the first value in input array
* will be the field value
*
* @param optionNumbers The option numbers
*
* @return The edited {@link PdfChoiceFormField}
*/
public PdfChoiceFormField setListSelected(int[] optionNumbers) {
if (optionNumbers.length > 1 && !isMultiSelect()) {
Logger logger = LoggerFactory.getLogger(this.getClass());
logger.warn(IoLogMessageConstant.MULTIPLE_VALUES_ON_A_NON_MULTISELECT_FIELD);
}
PdfArray indices = new PdfArray();
PdfArray values = new PdfArray();
PdfArray options = getOptions();
for (int number : optionNumbers) {
if (number >= 0 && number < options.size()) {
indices.add(new PdfNumber(number));
PdfObject option = options.get(number);
if (option.isString()) {
values.add(option);
} else if (option.isArray()) {
values.add(((PdfArray) option).get(0));
}
}
}
if (indices.size() > 0) {
setIndices(indices);
if (values.size() == 1) {
put(PdfName.V, values.get(0));
} else {
put(PdfName.V, values);
}
} else {
remove(PdfName.I);
remove(PdfName.V);
}
regenerateField();
return this;
}
/**
* Gets the currently selected items in the field
*
* @return a sorted array of indices representing the currently selected items in the field
*/
public PdfArray getIndices() {
return getPdfObject().getAsArray(PdfName.I);
}
/**
* If true, the field is a combo box; if false, the field is a list box.
*
* @param combo whether or not the field should be a combo box
*
* @return current {@link PdfChoiceFormField}
*/
public PdfChoiceFormField setCombo(boolean combo) {
return (PdfChoiceFormField) setFieldFlag(FF_COMBO, combo);
}
/**
* If true, the field is a combo box; if false, the field is a list box.
*
* @return whether or not the field is now a combo box.
*/
public boolean isCombo() {
return getFieldFlag(FF_COMBO);
}
/**
* If true, the combo box shall include an editable text box as well as a
* drop-down list; if false, it shall include only a drop-down list.
* This flag shall be used only if the Combo flag is true.
*
* @param edit whether or not to add an editable text box
*
* @return current {@link PdfChoiceFormField}
*/
public PdfChoiceFormField setEdit(boolean edit) {
return (PdfChoiceFormField) setFieldFlag(FF_EDIT, edit);
}
/**
* If true, the combo box shall include an editable text box as well as a
* drop-down list; if false, it shall include only a drop-down list.
* This flag shall be used only if the Combo flag is true.
*
* @return whether or not there is currently an editable text box
*/
public boolean isEdit() {
return getFieldFlag(FF_EDIT);
}
/**
* If true, the field's option items shall be sorted alphabetically.
* This flag is intended for use by writers, not by readers.
*
* @param sort whether or not to sort the items
*
* @return current {@link PdfChoiceFormField}
*/
public PdfChoiceFormField setSort(boolean sort) {
return (PdfChoiceFormField) setFieldFlag(FF_SORT, sort);
}
/**
* If true, the field's option items shall be sorted alphabetically.
* This flag is intended for use by writers, not by readers.
*
* @return whether or not the items are currently sorted
*/
public boolean isSort() {
return getFieldFlag(FF_SORT);
}
/**
* If true, more than one of the field's option items may be selected
* simultaneously; if false, at most one item shall be selected.
*
* @param multiSelect whether or not to allow multiple selection
*
* @return current {@link PdfChoiceFormField}
*/
public PdfChoiceFormField setMultiSelect(boolean multiSelect) {
return (PdfChoiceFormField) setFieldFlag(FF_MULTI_SELECT, multiSelect);
}
/**
* If true, more than one of the field's option items may be selected simultaneously; if false, at most one item
* shall be selected.
*
* @return whether or not multiple selection is currently allowed
*/
public boolean isMultiSelect() {
return getFieldFlag(FF_MULTI_SELECT);
}
/**
* If true, text entered in the field shall be spell-checked.
*
* @param spellCheck whether or not to require the PDF viewer to perform a spell check
*
* @return current {@link PdfChoiceFormField}
*/
public PdfChoiceFormField setSpellCheck(boolean spellCheck) {
return (PdfChoiceFormField) setFieldFlag(FF_DO_NOT_SPELL_CHECK, !spellCheck);
}
/**
* If true, text entered in the field shall be spell-checked..
*
* @return whether or not PDF viewer must perform a spell check
*/
public boolean isSpellCheck() {
return !getFieldFlag(FF_DO_NOT_SPELL_CHECK);
}
/**
* If true, the new value shall be committed as soon as a selection is made (commonly with the pointing device).
*
* @param commitOnSelChange whether or not to save changes immediately
*
* @return current {@link PdfChoiceFormField}
*/
public PdfChoiceFormField setCommitOnSelChange(boolean commitOnSelChange) {
return (PdfChoiceFormField) setFieldFlag(FF_COMMIT_ON_SEL_CHANGE, commitOnSelChange);
}
/**
* If true, the new value shall be committed as soon as a selection is made (commonly with the pointing device).
*
* @return whether or not to save changes immediately
*/
public boolean isCommitOnSelChange() {
return getFieldFlag(FF_COMMIT_ON_SEL_CHANGE);
}
private List optionsToUnicodeNames() {
PdfArray options = getOptions();
List optionsToUnicodeNames = new ArrayList(options.size());
for (int index = 0; index < options.size(); index++) {
PdfObject option = options.get(index);
PdfString value = null;
if (option.isString()) {
value = (PdfString) option;
} else if (option.isArray() && ((PdfArray) option).size() > 1) {
value = (PdfString) ((PdfArray) option).get(1);
}
optionsToUnicodeNames.add(value != null ? value.toUnicodeString() : null);
}
return optionsToUnicodeNames;
}
}
