Class PdfLayerMembership

java.lang.Object

com.aowagie.text.pdf.PdfObject

com.aowagie.text.pdf.PdfDictionary

com.aowagie.text.pdf.PdfLayerMembership

All Implemented Interfaces:

PdfOCG

class PdfLayerMembership
extends PdfDictionary
implements PdfOCG

Content typically belongs to a single optional content group, and is visible when the group is ON and invisible when it is OFF. To express more complex visibility policies, content should not declare itself to belong to an optional content group directly, but rather to an optional content membership dictionary represented by this class.

Field Summary

Fields

Modifier and Type	Field	Description
private final HashSet	layers
private final PdfArray	members
private final PdfIndirectReference	ref

Fields inherited from class PdfDictionary

CATALOG, hashMap, OUTLINES, PAGE

Fields inherited from class PdfObject

ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, NAME, NOTHING, NULL, NUMBER, STREAM, STRING, TEXT_PDFDOCENCODING, TEXT_UNICODE, type

Constructor Summary

Constructors

Constructor	Description
PdfLayerMembership(PdfWriter writer)	Creates a new, empty, membership layer.

Method Summary

Modifier and Type	Method	Description
Collection	getLayers()	Gets the member layers.
PdfObject	getPdfObject()	Gets the dictionary representing the membership layer.
PdfIndirectReference	getRef()	Gets the PdfIndirectReference that represents this membership layer.
void	setVisibilityPolicy(PdfName type)	Sets the visibility policy for content belonging to this membership dictionary.

Methods inherited from class PdfDictionary

contains, get, getAsArray, getAsBoolean, getAsDict, getAsIndirectObject, getAsName, getAsNumber, getAsString, getDirectObject, getKeys, isCatalog, isFont, isOutlineTree, isPage, isPages, merge, mergeDifferent, put, putAll, remove, size, toPdf, toString

Methods inherited from class PdfObject

canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, setContent, setIndRef, type

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

ref

private final PdfIndirectReference ref

members

private final PdfArray members

layers

private final HashSet layers

Constructor Details

PdfLayerMembership

public PdfLayerMembership(PdfWriter writer)

Creates a new, empty, membership layer.

Parameters:

writer - the writer

Method Details

getRef

public PdfIndirectReference getRef()

Gets the PdfIndirectReference that represents this membership layer.

Specified by:

getRef in interface PdfOCG

Returns:

the PdfIndirectReference that represents this layer

getLayers

public Collection getLayers()

Gets the member layers.

Returns:

the member layers

setVisibilityPolicy

public void setVisibilityPolicy(PdfName type)

Sets the visibility policy for content belonging to this membership dictionary. Possible values are ALLON, ANYON, ANYOFF and ALLOFF. The default value is ANYON.

Parameters:

type - the visibility policy

getPdfObject

public PdfObject getPdfObject()

Gets the dictionary representing the membership layer. It just returns this.

Specified by:

getPdfObject in interface PdfOCG

Returns:

the dictionary representing the layer