com.itextpdf.text.pdf

Class PdfLayer

java.lang.Object

com.itextpdf.text.pdf.PdfObject

com.itextpdf.text.pdf.PdfDictionary

com.itextpdf.text.pdf.PdfLayer

All Implemented Interfaces:

PdfOCG, Serializable

public class PdfLayer
extends PdfDictionary
implements PdfOCG

An optional content group is a dictionary representing a collection of graphics that can be made visible or invisible dynamically by users of viewer applications. In iText they are referenced as layers.

Author:

Paulo Soares

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList<PdfLayer>	children
protected PdfLayer	parent
protected PdfIndirectReference	ref
protected String	title

Fields inherited from class com.itextpdf.text.pdf.PdfDictionary

CATALOG, FONT, hashMap, OUTLINES, PAGE, PAGES

Fields inherited from class com.itextpdf.text.pdf.PdfObject

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

Constructor Summary

Constructors

Constructor and Description
PdfLayer(String name, PdfWriter writer) Creates a new layer.

Method Summary

Modifier and Type	Method and Description
void	addChild(PdfLayer child) Adds a child layer.
static PdfLayer	createTitle(String title, PdfWriter writer) Creates a title layer.
ArrayList<PdfLayer>	getChildren() Gets the children layers.
PdfLayer	getParent() Gets the parent layer.
PdfObject	getPdfObject() Gets the dictionary representing the layer.
PdfIndirectReference	getRef() Gets the PdfIndirectReference that represents this layer.
boolean	isOn() Gets the initial visibility of the layer.
boolean	isOnPanel() Gets the layer visibility in Acrobat's layer panel
void	setCreatorInfo(String creator, String subtype) Used by the creating application to store application-specific data associated with this optional content group.
void	setExport(boolean export) Specifies the recommended state for content in this group when the document (or part of it) is saved by a viewer application to a format that does not support optional content (for example, an earlier version of PDF or a raster image format).
void	setLanguage(String lang, boolean preferred) Specifies the language of the content controlled by this optional content group
void	setName(String name) Sets the name of this layer.
void	setOn(boolean on) Sets the initial visibility of the layer.
void	setOnPanel(boolean onPanel) Sets the visibility of the layer in Acrobat's layer panel.
void	setPageElement(String pe) Indicates that the group contains a pagination artifact.
void	setPrint(String subtype, boolean printstate) Specifies that the content in this group is intended for use in printing
void	setUser(String type, String... names) One of more users for whom this optional content group is primarily intended.
void	setView(boolean view) Indicates that the group should be set to that state when the document is opened in a viewer application.
void	setZoom(float min, float max) Specifies a range of magnifications at which the content in this optional content group is best viewed.

Methods inherited from class com.itextpdf.text.pdf.PdfDictionary

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

Methods inherited from class com.itextpdf.text.pdf.PdfObject

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

Methods inherited from class java.lang.Object

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

Field Detail

ref

protected PdfIndirectReference ref

children

protected ArrayList<PdfLayer> children

parent

protected PdfLayer parent

title

protected String title

Constructor Detail

PdfLayer

public PdfLayer(String name,
                PdfWriter writer)
         throws IOException

Creates a new layer.

Parameters:

name - the name of the layer

writer - the writer

Throws:

IOException

Method Detail

createTitle

public static PdfLayer createTitle(String title,
                                   PdfWriter writer)

Creates a title layer. A title layer is not really a layer but a collection of layers under the same title heading.

Parameters:

title - the title text

writer - the PdfWriter

Returns:

the title layer

addChild

public void addChild(PdfLayer child)

Adds a child layer. Nested layers can only have one parent.

Parameters:

child - the child layer

getParent

public PdfLayer getParent()

Gets the parent layer.

Returns:

the parent layer or null if the layer has no parent

getChildren

public ArrayList<PdfLayer> getChildren()

Gets the children layers.

Returns:

the children layers or null if the layer has no children

getRef

public PdfIndirectReference getRef()

Gets the PdfIndirectReference that represents this layer.

Specified by:

getRef in interface PdfOCG

Returns:

the PdfIndirectReference that represents this layer

setName

public void setName(String name)

Sets the name of this layer.

Parameters:

name - the name of this layer

getPdfObject

public PdfObject getPdfObject()

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

Specified by:

getPdfObject in interface PdfOCG

Returns:

the dictionary representing the layer

isOn

public boolean isOn()

Gets the initial visibility of the layer.

Returns:

the initial visibility of the layer

setOn

public void setOn(boolean on)

Sets the initial visibility of the layer.

Parameters:

on - the initial visibility of the layer

setCreatorInfo

public void setCreatorInfo(String creator,
                           String subtype)

Used by the creating application to store application-specific data associated with this optional content group.

Parameters:

creator - a text string specifying the application that created the group

subtype - a string defining the type of content controlled by the group. Suggested values include but are not limited to Artwork, for graphic-design or publishing applications, and Technical, for technical designs such as building plans or schematics

setLanguage

public void setLanguage(String lang,
                        boolean preferred)

Specifies the language of the content controlled by this optional content group

Parameters:

lang - a language string which specifies a language and possibly a locale (for example, es-MX represents Mexican Spanish)

preferred - used by viewer applications when there is a partial match but no exact match between the system language and the language strings in all usage dictionaries

setExport

public void setExport(boolean export)

Specifies the recommended state for content in this group when the document (or part of it) is saved by a viewer application to a format that does not support optional content (for example, an earlier version of PDF or a raster image format).

Parameters:

export - the export state

setZoom

public void setZoom(float min,
                    float max)

Specifies a range of magnifications at which the content in this optional content group is best viewed.

Parameters:

min - the minimum recommended magnification factors at which the group should be ON. A negative value will set the default to 0

max - the maximum recommended magnification factor at which the group should be ON. A negative value will set the largest possible magnification supported by the viewer application

setPrint

public void setPrint(String subtype,
                     boolean printstate)

Specifies that the content in this group is intended for use in printing

Parameters:

subtype - a name specifying the kind of content controlled by the group; for example, Trapping, PrintersMarks and Watermark

printstate - indicates that the group should be set to that state when the document is printed from a viewer application

setView

public void setView(boolean view)

Indicates that the group should be set to that state when the document is opened in a viewer application.

Parameters:

view - the view state

setPageElement

public void setPageElement(String pe)

Indicates that the group contains a pagination artifact.

Parameters:

pe - one of the following names: "HF" (Header Footer), "FG" (Foreground), "BG" (Background), or "L" (Logo).

Since:

5.0.2

setUser

public void setUser(String type,
                    String... names)

One of more users for whom this optional content group is primarily intended.

Parameters:

type - should be "Ind" (Individual), "Ttl" (Title), or "Org" (Organization).

names - one or more names

Since:

5.0.2

isOnPanel

public boolean isOnPanel()

Gets the layer visibility in Acrobat's layer panel

Returns:

the layer visibility in Acrobat's layer panel

setOnPanel

public void setOnPanel(boolean onPanel)

Sets the visibility of the layer in Acrobat's layer panel. If false the layer cannot be directly manipulated by the user. Note that any children layers will also be absent from the panel.

Parameters:

onPanel - the visibility of the layer in Acrobat's layer panel