com.lowagie.text.pdf

Class PdfStructureElement

public class PdfStructureElement extends PdfStructureBase

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

Author: Paulo Soares (psoares@consiste.pt) Something to keep in mind about MCIDs. They're not really IDentifiers. They're InDexes into their container(a page or annotation at the moment)'s kid array. The name has lead to misconceptions that can be found across several popular PDF products (including LifeCycle Designer 8).

Nested Class Summary
class	PdfStructureElement.PdfStructureMC A dictionary placed in the /K of a leaf structure element.
class	PdfStructureElement.PdfStructureObj Another dictionary residing in the /K of a leaf element.

Field Summary
boolean	hasPageMark
Integer	mcid
PdfStructureElement	parent
PdfStructureTreeRoot	top

Constructor Summary
	PdfStructureElement(PdfStructureElement parent, PdfName structureType) Creates a new instance of PdfStructureElement.
	PdfStructureElement(PdfStructureElement parent, PdfName structType, PdfIndirectReference ref) Constructs a new Element with a predetermined reference
	PdfStructureElement(PdfStructureTreeRoot parent, PdfName structureType) Creates a new instance of PdfStructureElement.

Method Summary
void	checkKids() Throw if this structure element is being used as a parent
static PdfStructureElement	createNextElement(PdfStructureElement parent, PdfName structureType) Creates a new element and immediately assigns it the next MCID.
int	getMCID() Get/assign a marked content ID for this element.
PdfDictionary	getParent() Gets the parent of this node.
PdfWriter	getWriter() Should never be null...
void	init(PdfStructureBase parent, PdfName structureType)
void	init(PdfStructureBase parent, PdfName structureType, PdfIndirectReference ref)
void	setMarkedContent(PdfIndirectReference pageRef) sets this structure element to represent a particular section of marked content within the page indicated by pageRef
void	setMarkedObject(PdfIndirectReference objRef, PdfIndirectReference pageRef) Sets this StructElem up as a marked object.
void	setMCID(int id) Will throw if this element has >0 kids
void	setObjMark()
void	setPageMark(int page)

Field Detail

hasPageMark

private boolean hasPageMark

mcid

private Integer mcid

parent

private PdfStructureElement parent

top

private PdfStructureTreeRoot top

Constructor Detail

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(PdfStructureElement parent, PdfName structType, PdfIndirectReference ref)

Constructs a new Element with a predetermined reference

Parameters: parent structType ref

Since: 2.1.5

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 Detail

checkKids

private void checkKids()

Throw if this structure element is being used as a parent

Since: 2.1.5

createNextElement

public static PdfStructureElement createNextElement(PdfStructureElement parent, PdfName structureType)

Creates a new element and immediately assigns it the next MCID. NOTE: MCIDs do NOT control reading order. That's handled by parent/child relationships of StructureElements alone.

Parameters: parent Structure Thing to contain the new element structureType durh.

Returns: the new element, with its freshly minted MCID already assigned. NOTE: There is no version of this function that can use the TreeRoot as its parent, because that would be silly. Think about it.

Since: 2.1.5