OptionalContentGroup Class Documentation

class OptionalContentGroup

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(Document doc, String name)

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

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

getIntent

java.util.List< String > getIntent()

Returns:

java.util.List< String >

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

String getName()

Returns:

String

the name

Get the name of the optional content group

getPDFDict

PDFDict getPDFDict()

Returns:

PDFDict

The underlying PDF dictionary for this OptionalContentGroup.

Retrieve the PDFObject representation of this object.

setIntent

void setIntent(java.util.List< String > intents)

Parameters

intents: java.util.List< String >

An array of intent strings to assign to this group.

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

void setName(String name)

Parameters

name: String

The new name for this OptionalContentGroup.

Returns:

void

Set the name of the optional content group.

toString

String toString()

Returns:

String

A string describing this OptionalContentGroup.

Returns a string representation of this OptionalContentGroup. The string includes the group's name and its intent list.