OptionalContentContext Class Documentation

class OptionalContentContext

Namespace:com::datalogics::PDFL

Detailed Description

Defines the context for optional content in a PDF. An Optional Content Context is a status object that defines the context for optional content within a document.

The context tracks the On/Off status for Optional Content Groups (layers) within a document. It contains flags that control whether to display content that is marked as optional.

Referenced by

AnnotationCircleAnnotationContainerContentDocumentDrawParamsFormFreeTextAnnotationHighlightAnnotationInkAnnotationLineAnnotationLinkAnnotationOptionalContentContextPagePolyLineAnnotationPolygonAnnotationPrintParamsRedactionSeparationParamsSquareAnnotationTextMarkupAnnotationUnderlineAnnotation

Constructor & Destructor Documentation

OptionalContentContext

OptionalContentContext(Document document)

Parameters

document: Document

The document for which to create a context.

Creates a context object that represents an optional-content state of the document, using the current state as the initial state for each group (OCG), as determined by the document's optional-content configuration.

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

getDrawOptionalContent

OptionalContentDrawingPolicy getDrawOptionalContent()

Returns:

OptionalContentDrawingPolicy

The drawing policy for optional content in this optional content context.

Gets the drawing policy for the optional content in this optional content context.

getOCGStates

java.util.List< Boolean > getOCGStates(java.util.List< OptionalContentGroup > ocgs)

Parameters

ocgs: java.util.List< OptionalContentGroup >

A list of optional-content groups whose states are obtained.

Returns:

java.util.List< Boolean >

An array of OCG states corresponding to the array of OCGs, true for ON and false for OFF.

Gets the ON-OFF states for the given optional-content groups (OCGs) in the given optional-content context.

getStateOfOCG

boolean getStateOfOCG(OptionalContentGroup ocg)

Parameters

ocg: OptionalContentGroup

The optional content group whose state will be retrieved.

Returns:

boolean

true if the OCG is ON, false if it is OFF.

Gets the ON-OFF state for the given optional content group (OCG) in this optional content context.

setDrawOptionalContent

void setDrawOptionalContent(OptionalContentDrawingPolicy newPolicy)

Parameters

newPolicy: OptionalContentDrawingPolicy

The new drawing policy for optional content in this optional content context.

Returns:

void

Sets the drawing policy for the optional content in this optional content context.

setOCGStates

void setOCGStates(java.util.List< OptionalContentGroup > ocgs, java.util.List< Boolean > newStates)

Parameters

ocgs: java.util.List< OptionalContentGroup >

A list of optional-content groups.

newStates: java.util.List< Boolean >

A list of new OCG states corresponding to the list of OCGs, true for ON and false for OFF. The list must contain as many states as there are non-NULL OCGs in the pdocgs list.

Returns:

void

Sets the ON-OFF states for the given optional-content groups (OCGs) in the given optional-content context. The newStates vector must be large enough to hold as many Boolean values as there are OCGs.

setStateOfOCG

void setStateOfOCG(OptionalContentGroup ocg, boolean newValue)

Parameters

ocg: OptionalContentGroup

The optional content group whose state will be set.

newValue: boolean

The new ON-OFF state for the optional content group.

Returns:

void

Sets the ON-OFF state for the given optional content group (OCG) in this optional content context.

toString

String toString()

Returns:

String

A string describing the state of all optional content groups in this context.

Returns a string representation of this OptionalContentContext. The string lists all optional content groups in the document along with their ON/OFF states in this context.