OptionalContentGroup Class Documentation

classOptionalContentGroup

Namespace:com::datalogics::PDFL

Detailed Description

A dictionary used to manage graphics images in a PDF. An Optional Content Group is a dictionary that represents a set of graphics images that users can turn on or off in a PDF document, making them visible or invisible.

In a PDF Viewer, Optional Content Groups are referred to as "Layers."

Referenced by

DocumentOptionalContentConfigOptionalContentContextOptionalContentGroupOptionalContentGroupVectorOptionalContentMembershipDictOptionalContentOrderLeaf

Constructor & Destructor Documentation

OptionalContentGroup

OptionalContentGroup(Documentdoc, Stringname)

Parameters

doc: Document

The document that the new OptionalContentGroup will belong to.

name: String

The name given to the new OptionalContentGroup.

Create a new OptionalContentGroup.

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

getIntent

java.util.List< String >getIntent()

Returns:

An array containing intent strings.

Gets the intent list for an optional-content group. An intent is a string value broadly describing the intended use, either View or Design.

A group's content is considered to be optional (that is, the group's state is considered in its visibility) if any intent in its list matches an intent of the context. The intent list of the context is usually set from the intent list of the document configuration.

getName

StringgetName()

Returns:

the name

Get the name of the optional content group

getPDFDict

PDFDictgetPDFDict()

Returns:

PDFDict

Retrieve the PDFObject representation of this object

setIntent

voidsetIntent(java.util.List< String >intents)

Parameters

intents: java.util.List< String >

Returns:

void

Sets the intent list for an optional-content group. An intent is a string value broadly describing the intended use, either View or Design.

A group's content is considered to be optional (that is, the group's state is considered in its visibility) if any intent in its list matches an intent of the context. The intent list of the context is usually set from the intent list of the document configuration.

setName

voidsetName(Stringname)

Parameters

name: String

Returns:

void

Set the name of the optional content group

toString

StringtoString()

Returns:

String