OptionalContentMembershipDict Class Documentation

classOptionalContentMembershipDict

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(Documentdoc, java.util.List< OptionalContentGroup >ocgs, VisibilityPolicyvp, PDFArrayvisibilityExpression)

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

DisposeChildren

voidDisposeChildren()

Returns:

void

[static initializer]

static void[static initializer]()

delete

synchronized voiddelete(Booleandisposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized voiddelete()

Returns:

synchronized void

equals

booleanequals(Objectrhs)

Parameters

rhs: Object

Returns:

boolean

finalize

voidfinalize()

Returns:

void

getOptionalContentGroups

java.util.List< OptionalContentGroup >getOptionalContentGroups()

Returns:

An array containing OptionalContentGroups.

Gets the list of OptionalContentGroups for this membership dictionary. This may consist of one OCG or several.

getVisibilityExpression

PDFArraygetVisibilityExpression()

Returns:

A Visibility Expression array.

GetVisibilityExpression Gets the Visibility Expression for this membership dictionary.

getVisibilityPolicy

VisibilityPolicygetVisibilityPolicy()

Returns:

A Visibility Policy.

Gets the Visbility Policy for this membership dictionary.

toString

StringtoString()

Returns:

String