Class PDOptionalContentGroup
- java.lang.Object
-
- org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDPropertyList
-
- org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentGroup
-
- All Implemented Interfaces:
COSObjectable
public class PDOptionalContentGroup extends PDPropertyList
An optional content group (OCG).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PDOptionalContentGroup.RenderState
Enumeration for the renderState dictionary entry on the "Export", "View" and "Print" dictionary.
-
Field Summary
-
Fields inherited from class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDPropertyList
dict
-
-
Constructor Summary
Constructors Constructor Description PDOptionalContentGroup(java.lang.String name)
Creates a new optional content group (OCG).PDOptionalContentGroup(COSDictionary dict)
Creates a new instance based on a givenCOSDictionary
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getName()
Returns the name of the optional content group.PDOptionalContentGroup.RenderState
getRenderState(RenderDestination destination)
void
setName(java.lang.String name)
Sets the name of the optional content group.java.lang.String
toString()
-
Methods inherited from class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDPropertyList
create, getCOSObject
-
-
-
-
Constructor Detail
-
PDOptionalContentGroup
public PDOptionalContentGroup(java.lang.String name)
Creates a new optional content group (OCG).- Parameters:
name
- the name of the content group
-
PDOptionalContentGroup
public PDOptionalContentGroup(COSDictionary dict)
Creates a new instance based on a givenCOSDictionary
.- Parameters:
dict
- the dictionary
-
-
Method Detail
-
getName
public java.lang.String getName()
Returns the name of the optional content group.- Returns:
- the name
-
setName
public void setName(java.lang.String name)
Sets the name of the optional content group.- Parameters:
name
- the name
-
getRenderState
public PDOptionalContentGroup.RenderState getRenderState(RenderDestination destination)
- Parameters:
destination
- to be rendered- Returns:
- state or null if undefined
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-