com.lowagie.text.pdf: public class: PdfStructureTreeRoot

com.lowagie.text.pdf
public class: PdfStructureTreeRoot [javadoc | source]

java.lang.Object
   com.lowagie.text.pdf.PdfObject
      com.lowagie.text.pdf.PdfDictionary
         com.lowagie.text.pdf.PdfStructureTreeRoot

The structure tree root corresponds to the highest hierarchy level in a tagged PDF.

author: Paulo - Soares (psoares@consiste.pt)

Fields inherited from com.lowagie.text.pdf.PdfDictionary:
FONT, OUTLINES, PAGE, PAGES, CATALOG, hashMap

Fields inherited from com.lowagie.text.pdf.PdfObject:
BOOLEAN, NUMBER, STRING, NAME, ARRAY, DICTIONARY, STREAM, NULL, INDIRECT, NOTHING, TEXT_PDFDOCENCODING, TEXT_UNICODE, bytes, type, indRef

Constructor:
PdfStructureTreeRoot(PdfWriter writer) { super(PdfName.STRUCTTREEROOT); this.writer = writer; reference = writer.getPdfIndirectReference(); } Creates a new instance of PdfStructureTreeRoot

Constructor:

 PdfStructureTreeRoot(PdfWriter writer) {
    
        super(PdfName.STRUCTTREEROOT);
        this.writer = writer;
        reference = writer.getPdfIndirectReference();
}

Creates a new instance of PdfStructureTreeRoot

Method from com.lowagie.text.pdf.PdfStructureTreeRoot Summary:
buildTree, getReference, getWriter, mapRole, setPageMark

Methods from 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 from com.lowagie.text.pdf.PdfObject:
canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, toPdf, toString, type

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from com.lowagie.text.pdf.PdfStructureTreeRoot Detail:
void buildTree() throws IOException { HashMap numTree = new HashMap(); for (Iterator it = parentTree.keySet().iterator(); it.hasNext();) { Integer i = (Integer)it.next(); PdfArray ar = (PdfArray)parentTree.get(i); numTree.put(i, writer.addToBody(ar).getIndirectReference()); } PdfDictionary dicTree = PdfNumberTree.writeTree(numTree, writer); if (dicTree != null) put(PdfName.PARENTTREE, writer.addToBody(dicTree).getIndirectReference()); nodeProcess(this, reference); }
public PdfIndirectReference getReference() { return this.reference; } Gets the reference this object will be written to.
public PdfWriter getWriter() { return this.writer; } Gets the writer.
public void mapRole(PdfName used, PdfName standard) { PdfDictionary rm = (PdfDictionary)get(PdfName.ROLEMAP); if (rm == null) { rm = new PdfDictionary(); put(PdfName.ROLEMAP, rm); } rm.put(used, standard); } Maps the user tags to the standard tags. The mapping will allow a standard application to make some sense of the tagged document whatever the user tags may be.
void setPageMark(int page, PdfIndirectReference struc) { Integer i = new Integer(page); PdfArray ar = (PdfArray)parentTree.get(i); if (ar == null) { ar = new PdfArray(); parentTree.put(i, ar); } ar.add(struc); }