|
![]() |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.lowagie.text.pdf.PdfObject
com.lowagie.text.pdf.PdfDictionary
com.lowagie.text.pdf.PdfStructureBase
com.lowagie.text.pdf.PdfStructureElement
public class PdfStructureElement
This is a node in a document logical structure. It may contain a mark point or it may contain other nodes.
Nested Class Summary | |
---|---|
(package private) class |
PdfStructureElement.PdfStructureMC
A dictionary placed in the /K of a leaf structure element. |
(package private) class |
PdfStructureElement.PdfStructureObj
Another dictionary residing in the /K of a leaf element. |
Field Summary | |
---|---|
private boolean |
hasPageMark
|
private java.lang.Integer |
mcid
|
private PdfStructureElement |
parent
|
private PdfStructureTreeRoot |
top
|
Fields inherited from class com.lowagie.text.pdf.PdfStructureBase |
---|
kids |
Fields inherited from class com.lowagie.text.pdf.PdfDictionary |
---|
CATALOG, FONT, hashMap, OUTLINES, PAGE, PAGES |
Fields inherited from class com.lowagie.text.pdf.PdfObject |
---|
ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, indRef, NAME, NOTHING, NULL, NUMBER, STREAM, STRING, TEXT_PDFDOCENCODING, TEXT_UNICODE, type |
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 | |
---|---|
private 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... |
private void |
init(PdfStructureBase parent,
PdfName structureType)
|
private 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 |
private void |
setObjMark()
|
(package private) void |
setPageMark(int page)
|
Methods inherited from class com.lowagie.text.pdf.PdfStructureBase |
---|
addKid, getIndRef |
Methods inherited from class com.lowagie.text.pdf.PdfDictionary |
---|
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.lowagie.text.pdf.PdfObject |
---|
canBeInObjStm, getBytes, getDirectObject, 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 |
---|
private PdfStructureElement parent
private PdfStructureTreeRoot top
private java.lang.Integer mcid
private boolean hasPageMark
Constructor Detail |
---|
public PdfStructureElement(PdfStructureElement parent, PdfName structureType)
parent
- the parent of this nodestructureType
- the type of structure. It may be a standard type or a user type mapped by the role mappublic PdfStructureElement(PdfStructureElement parent, PdfName structType, PdfIndirectReference ref)
parent
- structType
- ref
- public PdfStructureElement(PdfStructureTreeRoot parent, PdfName structureType)
parent
- the parent of this nodestructureType
- the type of structure. It may be a standard type or a user type mapped by the role mapMethod Detail |
---|
public static PdfStructureElement createNextElement(PdfStructureElement parent, PdfName structureType)
parent
- Structure Thing to contain the new elementstructureType
- durh.
public PdfWriter getWriter()
getWriter
in class PdfStructureBase
private void init(PdfStructureBase parent, PdfName structureType)
private void init(PdfStructureBase parent, PdfName structureType, PdfIndirectReference ref)
public PdfDictionary getParent()
public int getMCID()
public void setMCID(int id)
id
- MCIDpublic void setMarkedContent(PdfIndirectReference pageRef)
pageRef
- the reference to a particular pagepublic void setMarkedObject(PdfIndirectReference objRef, PdfIndirectReference pageRef)
objRef
- requiredpageRef
- may be nullvoid setPageMark(int page)
page
- private void setObjMark()
private void checkKids()
|
Hosted by Hostbasket | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |