Package com.pdftools.toolbox.pdf.forms

Enum FormFieldCopyStrategy

java.lang.Object

java.lang.Enum<FormFieldCopyStrategy>

com.pdftools.toolbox.pdf.forms.FormFieldCopyStrategy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FormFieldCopyStrategy>

public enum FormFieldCopyStrategy
extends java.lang.Enum<FormFieldCopyStrategy>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COPY	The elements are copied as-is to the target document.
COPY_AND_UPDATE_WIDGETS	Copy widgets that belong to form fields copied previously with FieldNode.copy(com.pdftools.toolbox.pdf.Document, com.pdftools.toolbox.pdf.forms.FieldNode).
FLATTEN	The elements are removed but the visible representation is retained.
REMOVE	The elements are removed completely.

Method Summary

Modifier and Type	Method	Description
static FormFieldCopyStrategy	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static FormFieldCopyStrategy[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

COPY

public static final FormFieldCopyStrategy COPY

The elements are copied as-is to the target document.

FLATTEN

public static final FormFieldCopyStrategy FLATTEN

The elements are removed but the visible representation is retained.

REMOVE

public static final FormFieldCopyStrategy REMOVE

The elements are removed completely.

COPY_AND_UPDATE_WIDGETS

public static final FormFieldCopyStrategy COPY_AND_UPDATE_WIDGETS

Copy widgets that belong to form fields copied previously with FieldNode.copy(com.pdftools.toolbox.pdf.Document, com.pdftools.toolbox.pdf.forms.FieldNode). Any changes made to copied form fields are reflected in the widgets.

Method Detail

values

public static FormFieldCopyStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FormFieldCopyStrategy c : FormFieldCopyStrategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FormFieldCopyStrategy valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null