Package com.aowagie.text.pdf
Class PdfLayer
- java.lang.Object
-
- com.aowagie.text.pdf.PdfObject
-
- com.aowagie.text.pdf.PdfDictionary
-
- com.aowagie.text.pdf.PdfLayer
-
- All Implemented Interfaces:
PdfOCG
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.
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.ArrayList
children
private boolean
on
Holds value of property on.private boolean
onPanel
Holds value of property onPanel.private PdfLayer
parent
private PdfIndirectReference
ref
private java.lang.String
title
-
Fields inherited from class com.aowagie.text.pdf.PdfDictionary
CATALOG, hashMap, OUTLINES, PAGE
-
Fields inherited from class com.aowagie.text.pdf.PdfObject
ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, NAME, NOTHING, NULL, NUMBER, STREAM, STRING, TEXT_PDFDOCENCODING, TEXT_UNICODE, type
-
-
Constructor Summary
Constructors Constructor Description PdfLayer(java.lang.String title)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description (package private) void
addChild(PdfLayer child)
Adds a child layer.java.util.ArrayList
getChildren()
Gets the children layers.PdfLayer
getParent()
Gets the parent layer.PdfObject
getPdfObject()
Gets the dictionary representing the layer.PdfIndirectReference
getRef()
Gets thePdfIndirectReference
that represents this layer.(package private) java.lang.String
getTitle()
private PdfDictionary
getUsage()
boolean
isOn()
Gets the initial visibility of the layer.boolean
isOnPanel()
Gets the layer visibility in Acrobat's layer panelvoid
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
setName(java.lang.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.(package private) void
setRef(PdfIndirectReference ref)
Sets thePdfIndirectReference
that represents this layer.void
setView(boolean view)
Indicates that the group should be set to that state when the document is opened in a viewer application.-
Methods inherited from class com.aowagie.text.pdf.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 com.aowagie.text.pdf.PdfObject
canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, setContent, setIndRef, type
-
-
-
-
Field Detail
-
ref
private PdfIndirectReference ref
-
children
private java.util.ArrayList children
-
parent
private PdfLayer parent
-
title
private final java.lang.String title
-
on
private boolean on
Holds value of property on.
-
onPanel
private boolean onPanel
Holds value of property onPanel.
-
-
Method Detail
-
getTitle
java.lang.String getTitle()
-
addChild
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 java.util.ArrayList getChildren()
Gets the children layers.- Returns:
- the children layers or
null
if the layer has no children
-
getRef
public PdfIndirectReference getRef()
Gets thePdfIndirectReference
that represents this layer.
-
setRef
void setRef(PdfIndirectReference ref)
Sets thePdfIndirectReference
that represents this layer. This can only be done from PdfStamperImp.- Parameters:
ref
- The reference to the OCG object- Since:
- 2.1.2
-
setName
public void setName(java.lang.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 returnsthis
.- Specified by:
getPdfObject
in interfacePdfOCG
- 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
-
getUsage
private PdfDictionary getUsage()
-
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
-
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
-
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. Iffalse
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
-
-