Class PdfStructureElement

java.lang.Object

com.gitlab.pdftk_java.com.lowagie.text.pdf.PdfObject

com.gitlab.pdftk_java.com.lowagie.text.pdf.PdfDictionary

com.gitlab.pdftk_java.com.lowagie.text.pdf.PdfStructureElement

public class PdfStructureElement
extends PdfDictionary

This is a node in a document logical structure. It may contain a mark point or it may contain other nodes.

Field Summary

Fields

Modifier and Type	Field	Description
private PdfStructureElement	parent	Holds value of property kids.
private PdfIndirectReference	reference	Holds value of property reference.
private PdfStructureTreeRoot	top

Fields inherited from class PdfDictionary

CATALOG, FONT, hashMap, OUTLINES, PAGE, PAGES

Fields inherited from class PdfObject

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

Constructor Summary

Constructors

Constructor	Description
PdfStructureElement(PdfStructureElement parent, PdfName structureType)	Creates a new instance of PdfStructureElement.
PdfStructureElement(PdfStructureTreeRoot parent, PdfName structureType)	Creates a new instance of PdfStructureElement.

Method Summary

Modifier and Type	Method	Description
PdfDictionary	getParent()	Gets the parent of this node.
PdfIndirectReference	getReference()	Gets the reference this object will be written to.
private void	init(PdfDictionary parent, PdfName structureType)
(package private) void	setPageMark(int page, int mark)

Methods inherited from class PdfDictionary

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

Methods inherited from class PdfObject

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

Methods inherited from class Object

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

Field Details

parent

private PdfStructureElement parent

Holds value of property kids.

top

private PdfStructureTreeRoot top

reference

private PdfIndirectReference reference

Holds value of property reference.

Constructor Details

PdfStructureElement

public PdfStructureElement(PdfStructureElement parent,
 PdfName structureType)

Creates a new instance of PdfStructureElement.

Parameters:

parent - the parent of this node

structureType - the type of structure. It may be a standard type or a user type mapped by the role map

PdfStructureElement

public PdfStructureElement(PdfStructureTreeRoot parent,
 PdfName structureType)

Creates a new instance of PdfStructureElement.

Parameters:

parent - the parent of this node

structureType - the type of structure. It may be a standard type or a user type mapped by the role map

Method Details

init

private void init(PdfDictionary parent,
 PdfName structureType)

getParent

public PdfDictionary getParent()

Gets the parent of this node.

Returns:

the parent of this node

setPageMark

void setPageMark(int page,
 int mark)

getReference

public PdfIndirectReference getReference()

Gets the reference this object will be written to.

Returns:

the reference this object will be written to