Package org.faceless.pdf2

Enum OptionalContentLayer.When

java.lang.Object

java.lang.Enum<OptionalContentLayer.When>

org.faceless.pdf2.OptionalContentLayer.When

All Implemented Interfaces:

Serializable, Comparable<OptionalContentLayer.When>

Enclosing class:

OptionalContentLayer

public static enum OptionalContentLayer.When
extends Enum<OptionalContentLayer.When>

The "When" enum can be used to set under what conditions a layer is printed/exported.

Enum Constant Summary

Enum Constants

Enum Constant	Description
Always	The layer will always be included.
Enabled	The layer will be included when it is enabled in the UI.
Never	The layer will never be included.
Toggle	If the layer is currently "Always", make it "Never", otherwise make it "Always".

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Enabled

public static final OptionalContentLayer.When Enabled

The layer will be included when it is enabled in the UI.

Always

public static final OptionalContentLayer.When Always

The layer will always be included.

Never

public static final OptionalContentLayer.When Never

The layer will never be included.

Toggle

public static final OptionalContentLayer.When Toggle

If the layer is currently "Always", make it "Never", otherwise make it "Always". This value can be passed into PDFAction.showOptionalContent(java.util.Map<org.faceless.pdf2.OptionalContentLayer, org.faceless.pdf2.OptionalContentLayer.When>, boolean) method. If used anywhere else, it will be ignored.

Since:

2.24.2

Method Detail

values

public static OptionalContentLayer.When[] 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 (OptionalContentLayer.When c : OptionalContentLayer.When.values())
    System.out.println(c);

Returns:

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

valueOf

public static OptionalContentLayer.When valueOf(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:

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

NullPointerException - if the argument is null