Class PDOptionalContentMembershipDictionary
- java.lang.Object
-
- org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDPropertyList
-
- org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentMembershipDictionary
-
- All Implemented Interfaces:
COSObjectable
public class PDOptionalContentMembershipDictionary extends PDPropertyList
An optional content membership dictionary (OCMD).
-
-
Field Summary
-
Fields inherited from class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDPropertyList
dict
-
-
Constructor Summary
Constructors Constructor Description PDOptionalContentMembershipDictionary()
Creates a new optional content membership dictionary (OCMD).PDOptionalContentMembershipDictionary(COSDictionary dict)
Creates a new instance based on a givenCOSDictionary
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<PDPropertyList>
getOCGs()
Get a list of optional content groups.COSName
getVisibilityPolicy()
Get the visibility policy name.void
setOCGs(java.util.List<PDPropertyList> ocgs)
Set optional content groups as a list.void
setVisibilityPolicy(COSName visibilityPolicy)
Sets the visibility policy name.-
Methods inherited from class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDPropertyList
create, getCOSObject
-
-
-
-
Constructor Detail
-
PDOptionalContentMembershipDictionary
public PDOptionalContentMembershipDictionary()
Creates a new optional content membership dictionary (OCMD).
-
PDOptionalContentMembershipDictionary
public PDOptionalContentMembershipDictionary(COSDictionary dict)
Creates a new instance based on a givenCOSDictionary
.- Parameters:
dict
- the dictionary
-
-
Method Detail
-
getOCGs
public java.util.List<PDPropertyList> getOCGs()
Get a list of optional content groups.- Returns:
- List of optional content groups, never null.
-
setOCGs
public void setOCGs(java.util.List<PDPropertyList> ocgs)
Set optional content groups as a list.- Parameters:
ocgs
- list of optional content groups to set.
-
getVisibilityPolicy
public COSName getVisibilityPolicy()
Get the visibility policy name. Valid names are AllOff, AllOn, AnyOff, AnyOn (default).- Returns:
- the visibility policy, never null.
-
setVisibilityPolicy
public void setVisibilityPolicy(COSName visibilityPolicy)
Sets the visibility policy name. Valid names are AllOff, AllOn, AnyOff, AnyOn (default).- Parameters:
visibilityPolicy
-
-
-