Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.graphics.optionalcontent

public Class PDOptionalContentMembershipDictionary

extends PDPropertyList
Class Inheritance
Imports
java.util.ArrayList, .Collections, .List, org.apache.pdfbox.cos.COSArray, .COSBase, .COSDictionary, .COSName, org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDPropertyList

An optional content membership dictionary (OCMD).
Author
Tilman Hausherr

Field Summary

Inherited from org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDPropertyList:
dict

Constructor Summary

AccessConstructor and Description
public
PDOptionalContentMembershipDictionary()

Creates a new optional content membership dictionary (OCMD).

public
PDOptionalContentMembershipDictionary(COSDictionary
the dictionary
dict
)

Creates a new instance based on a given COSDictionary.

Method Summary

Modifier and TypeMethod and Description
public List<PDPropertyList>

Returns:

List of optional content groups, never null.
getOCGs
()

Get a list of optional content groups.

public COSName

Returns:

the visibility policy, never null.
getVisibilityPolicy
()

Get the visibility policy name.

public void
setOCGs(List<PDPropertyList>
list of optional content groups to set.
ocgs
)

Set optional content groups as a list.

public void
setVisibilityPolicy(COSName
the visibility policy name
visibilityPolicy
)

Sets the visibility policy name.

Inherited from org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDPropertyList:
creategetCOSObject

Constructor Detail

PDOptionalContentMembershipDictionaryback to summary
public PDOptionalContentMembershipDictionary()

Creates a new optional content membership dictionary (OCMD).

PDOptionalContentMembershipDictionaryback to summary
public PDOptionalContentMembershipDictionary(COSDictionary dict)

Creates a new instance based on a given COSDictionary.

Parameters
dict:COSDictionary

the dictionary

Method Detail

getOCGsback to summary
public List<PDPropertyList> getOCGs()

Get a list of optional content groups.

Returns:List<PDPropertyList>

List of optional content groups, never null.

getVisibilityPolicyback to summary
public COSName getVisibilityPolicy()

Get the visibility policy name. Valid names are AllOff, AllOn, AnyOff, AnyOn (default).

Returns:COSName

the visibility policy, never null.

setOCGsback to summary
public void setOCGs(List<PDPropertyList> ocgs)

Set optional content groups as a list.

Parameters
ocgs:List<PDPropertyList>

list of optional content groups to set.

setVisibilityPolicyback to summary
public void setVisibilityPolicy(COSName visibilityPolicy)

Sets the visibility policy name. Valid names are AllOff, AllOn, AnyOff, AnyOn (default).

Parameters
visibilityPolicy:COSName

the visibility policy name