Enum PDOptionalContentGroup.RenderState
- java.lang.Object
-
- java.lang.Enum<PDOptionalContentGroup.RenderState>
-
- org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentGroup.RenderState
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<PDOptionalContentGroup.RenderState>
- Enclosing class:
- PDOptionalContentGroup
public static enum PDOptionalContentGroup.RenderState extends java.lang.Enum<PDOptionalContentGroup.RenderState>
Enumeration for the renderState dictionary entry on the "Export", "View" and "Print" dictionary.
-
-
Constructor Summary
Constructors Modifier Constructor Description private
RenderState(COSName value)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description COSName
getName()
Returns the PDF name for the state.static PDOptionalContentGroup.RenderState
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static PDOptionalContentGroup.RenderState
valueOf(COSName state)
Returns the base state represented by the givenCOSName
.static PDOptionalContentGroup.RenderState[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
ON
public static final PDOptionalContentGroup.RenderState ON
The "ON" value.
-
OFF
public static final PDOptionalContentGroup.RenderState OFF
The "OFF" value.
-
-
Field Detail
-
name
private final COSName name
-
-
Constructor Detail
-
RenderState
private RenderState(COSName value)
-
-
Method Detail
-
values
public static PDOptionalContentGroup.RenderState[] 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 (PDOptionalContentGroup.RenderState c : PDOptionalContentGroup.RenderState.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static PDOptionalContentGroup.RenderState 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 namejava.lang.NullPointerException
- if the argument is null
-
valueOf
public static PDOptionalContentGroup.RenderState valueOf(COSName state)
Returns the base state represented by the givenCOSName
.- Parameters:
state
- the state name- Returns:
- the state enum value
-
getName
public COSName getName()
Returns the PDF name for the state.- Returns:
- the name of the state
-
-