OptionalContentMembershipDict Class Documentation

class OptionalContentMembershipDict

Namespace:com::datalogics::PDFL

Detailed Description

Attaches content to one or more optional content groups. Form, container, and annotation objects can be associated with one or more optional content groups. By associating them with an optional content group, they become part of that 'layer', and the user can control the visibility of the content.

Note that by placing other element objects in a container, they can also be associated with an optional content group.

An OptionalContentMembershipDict connects content to the OptionalContentGroup; it contains a list of OptionalContentGroups, and rules for determining visibility when the OptionalContentGroups have conflicting on/off states in the active OptionalContentContext.

An OptionalContentMembershipDict cannot be changed once created; you must create a new OptionalContentMembershipDict and change the objects to point to it.

Referenced by

AnnotationCircleAnnotationContainerFormFreeTextAnnotationHighlightAnnotationInkAnnotationLineAnnotationLinkAnnotationOptionalContentMembershipDictPolyLineAnnotationPolygonAnnotationRedactionSquareAnnotationTextMarkupAnnotationUnderlineAnnotation

Constructor & Destructor Documentation

OptionalContentMembershipDict

OptionalContentMembershipDict(Document doc, java.util.List< OptionalContentGroup > ocgs, VisibilityPolicy vp)

Parameters

doc: Document

The document that the new OptionalContentMembershipDict will belong to.

ocgs: java.util.List< OptionalContentGroup >

The list of OptionalContentGroups this MembershipDict refers to.

vp: VisibilityPolicy

The VisibilityPolicy of this MembershipDict.

Create a new OptionalContentMembershipDict.

OptionalContentMembershipDict

OptionalContentMembershipDict(Document doc, java.util.List< OptionalContentGroup > ocgs, VisibilityPolicy vp, PDFArray visibilityExpression)

Parameters

doc: Document

The document that the new OptionalContentMembershipDict will belong to.

ocgs: java.util.List< OptionalContentGroup >

The list of OptionalContentGroups this MembershipDict refers to.

vp: VisibilityPolicy

The VisibilityPolicy of this MembershipDict.

visibilityExpression: PDFArray

The VisibilityExpression of this MembershipDict.

Create a new OptionalContentMembershipDict.

Member Function Documentation

delete

synchronized void delete(Boolean disposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized void delete()

Returns:

synchronized void

equals

boolean equals(Object rhs)

Parameters

rhs: Object

Returns:

boolean

finalize

void finalize()

Returns:

void

getVisibilityExpression

PDFArray getVisibilityExpression()

Returns:

PDFArray

A Visibility Expression array.

GetVisibilityExpression Gets the Visibility Expression for this membership dictionary.

getVisibilityPolicy

VisibilityPolicy getVisibilityPolicy()

Returns:

VisibilityPolicy

A Visibility Policy.

Gets the Visbility Policy for this membership dictionary.

toString

String toString()

Returns:

String

A string describing this OptionalContentMembershipDict.

Returns a string representation of this OptionalContentMembershipDict. The string includes the names of all associated OptionalContentGroups and the current VisibilityPolicy.