Package com.itextpdf.html2pdf.attach.impl

Class OutlineHandler

java.lang.Object

com.itextpdf.html2pdf.attach.impl.OutlineHandler

       public class OutlineHandler extends Object
      

A OutlineHandler handles creating outlines for marks. Marks are extracted via interface IOutlineMarkExtractor.

This class is not reusable and a new instance shall be created for every new conversion process.

Field Summary

Fields

Modifier and Type	Field	Description
protected com.itextpdf.kernel.pdf.PdfOutline	currentOutline	The current outline.
protected DequeString,com.itextpdf.kernel.pdf.PdfDictionary>>	destinationsInProcess	The destinations in process.
protected Deque<Integer>	levelsInProcess	The levels in process.
protected IOutlineMarkExtractor	markExtractor	The mark extractor defines what part of element will be used to create outline

Constructor Summary

Constructors

Constructor	Description
OutlineHandler()	Creates an OutlineHandler with standard TagOutlineMarkExtractor.

Method Summary

Modifier and Type	Method	Description
protected OutlineHandler	addOutlineAndDestToDocument(ITagWorker tagWorker, com.itextpdf.styledxmlparser.node.IElementNode element, ProcessorContext context)	Adds the outline and the destination.
static OutlineHandler	createHandler(IOutlineMarkExtractor extractor)	Creates an OutlineHandler with custom IOutlineMarkExtractor
static OutlineHandler	createStandardHandler()	Creates an OutlineHandler with standard TagOutlineMarkExtractor and predefined mappings.
protected String	generateOutlineName(com.itextpdf.styledxmlparser.node.IElementNode element)	Generate the outline name.
protected String	generateUniqueDestinationName(com.itextpdf.styledxmlparser.node.IElementNode element)	Generate the unique destination name.
String	getDestinationNamePrefix()	Gets the destination name prefix.
IOutlineMarkExtractor	getMarkExtractor()	Get mark extractor.
Integer	getMarkPriorityMapping(String markName)	Gets the mark from priority mapping.
Integer	getTagPriorityMapping(String tagName)	Deprecated. use getMarkPriorityMapping(String) instead
boolean	hasMarkPriorityMapping(String markName)	Checks for tag in priority mapping.
boolean	hasTagPriorityMapping(String tagName)	Deprecated. use hasMarkPriorityMapping(String) instead
OutlineHandler	putAllMarksPriorityMappings(Map<String,Integer> mappings)	Put all marks into priority mappings.
OutlineHandler	putAllTagPriorityMappings(Map<String,Integer> mappings)	Deprecated. ue putAllMarksPriorityMappings(Map) instead
OutlineHandler	putMarkPriorityMapping(String markName, Integer priority)	Put mark into priority mapping.
OutlineHandler	putTagPriorityMapping(String tagName, Integer priority)	Deprecated. use putMarkPriorityMapping(String, Integer) instead
void	reset()	Resets the current state so that this OutlineHandler is ready to process new document
void	setDestinationNamePrefix(String destinationNamePrefix)	Sets the destination name prefix.
protected OutlineHandler	setDestinationToElement(ITagWorker tagWorker, com.itextpdf.styledxmlparser.node.IElementNode element)	Sets the destination to element.
OutlineHandler	setMarkExtractor(IOutlineMarkExtractor extractor)	Set mark extractor.

Methods inherited from class java.lang.Object

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

Field Details

currentOutline

             protected com.itextpdf.kernel.pdf.PdfOutline currentOutline
            

The current outline.

destinationsInProcess

             protected DequeString,com.itextpdf.kernel.pdf.PdfDictionary>> destinationsInProcess
            

The destinations in process.

levelsInProcess

             protected Deque<Integer> levelsInProcess
            

The levels in process.

markExtractor

             protected IOutlineMarkExtractor markExtractor
            

The mark extractor defines what part of element will be used to create outline

Constructor Details

OutlineHandler

             public OutlineHandler()
            

Creates an OutlineHandler with standard TagOutlineMarkExtractor.

Method Details

createStandardHandler

             public static OutlineHandler createStandardHandler()
            

Creates an OutlineHandler with standard TagOutlineMarkExtractor and predefined mappings.

Returns:

the outline handler

createHandler

             public static OutlineHandler createHandler
             (IOutlineMarkExtractor extractor)
            

Creates an OutlineHandler with custom IOutlineMarkExtractor

Parameters:

extractor - the mark extractor

Returns:

the outline handler

getMarkExtractor

             public IOutlineMarkExtractor getMarkExtractor()
            

Get mark extractor.

Returns:

the mark extractor

setMarkExtractor

             public OutlineHandler setMarkExtractor
             (IOutlineMarkExtractor extractor)
            

Set mark extractor.

Parameters:

extractor - the mark extractor

Returns:

the outline handler

putTagPriorityMapping

             @Deprecated public OutlineHandler putTagPriorityMapping
             (String tagName, Integer priority)
            

Deprecated.

use putMarkPriorityMapping(String, Integer) instead

Put tag into priority mapping.

Parameters:

tagName - the tag name

priority - the priority

Returns:

the outline handler

putMarkPriorityMapping

             public OutlineHandler putMarkPriorityMapping
             (String markName, Integer priority)
            

Put mark into priority mapping.

Parameters:

markName - the mark name

priority - the priority

Returns:

the outline handler

putAllTagPriorityMappings

             @Deprecated public OutlineHandler putAllTagPriorityMappings
             (Map<String,Integer> mappings)
            

Deprecated.

ue putAllMarksPriorityMappings(Map) instead

Put all tags into priority mappings.

Parameters:

mappings - the mappings

Returns:

the outline handler

putAllMarksPriorityMappings

             public OutlineHandler putAllMarksPriorityMappings
             (Map<String,Integer> mappings)
            

Put all marks into priority mappings.

Parameters:

mappings - the mappings

Returns:

the outline handler

getTagPriorityMapping

             @Deprecated public Integer getTagPriorityMapping
             (String tagName)
            

Deprecated.

use getMarkPriorityMapping(String) instead

Gets the marks from priority mapping.

Parameters:

tagName - the tag name

Returns:

the tag priority mapping

getMarkPriorityMapping

             public Integer getMarkPriorityMapping
             (String markName)
            

Gets the mark from priority mapping.

Parameters:

markName - the mark name

Returns:

the tag priority mapping

hasTagPriorityMapping

             @Deprecated public boolean hasTagPriorityMapping
             (String tagName)
            

Deprecated.

use hasMarkPriorityMapping(String) instead

Checks for tag in priority mapping.

Parameters:

tagName - the tag name

Returns:

true, if the tag name is listed in the tag priorities mapping

hasMarkPriorityMapping

             public boolean hasMarkPriorityMapping
             (String markName)
            

Checks for tag in priority mapping.

Parameters:

markName - the mark name

Returns:

true, if the tag name is listed in the tag priorities mapping

reset

             public void reset()
            

Resets the current state so that this OutlineHandler is ready to process new document

setDestinationNamePrefix

             public void setDestinationNamePrefix
             (String destinationNamePrefix)
            

Sets the destination name prefix. The destination name prefix serves as the prefix for the destination names created in the generateUniqueDestinationName(com.itextpdf.styledxmlparser.node.IElementNode) method.

Parameters:

destinationNamePrefix - the destination name prefix

getDestinationNamePrefix

             public String getDestinationNamePrefix()
            

Gets the destination name prefix. The destination name prefix serves as the prefix for the destination names created in the generateUniqueDestinationName(com.itextpdf.styledxmlparser.node.IElementNode) method.

Returns:

the destination name prefix

generateUniqueDestinationName

             protected String generateUniqueDestinationName
             (com.itextpdf.styledxmlparser.node.IElementNode element)
            

Generate the unique destination name. The destination name is a unique identifier for the outline so it is generated for the outline in the addOutlineAndDestToDocument(com.itextpdf.html2pdf.attach.ITagWorker, com.itextpdf.styledxmlparser.node.IElementNode, com.itextpdf.html2pdf.attach.ProcessorContext) method. You can override this method to set your own way to generate the destination names, to avoid the destination name conflicts when merging several PDF files created by html2pdf.

Parameters:

element - the element

Returns:

the unique destination name

generateOutlineName

             protected String generateOutlineName
             (com.itextpdf.styledxmlparser.node.IElementNode element)
            

Generate the outline name. This method is used in the addOutlineAndDestToDocument(com.itextpdf.html2pdf.attach.ITagWorker, com.itextpdf.styledxmlparser.node.IElementNode, com.itextpdf.html2pdf.attach.ProcessorContext) method. You can override this method to set your own way to generate the outline names.

Parameters:

element - the element

Returns:

the unique destination name

addOutlineAndDestToDocument

             protected OutlineHandler addOutlineAndDestToDocument
             (ITagWorker tagWorker, com.itextpdf.styledxmlparser.node.IElementNode element, ProcessorContext context)
            

Adds the outline and the destination. Adds the outline and its corresponding the destination to the PDF document if the priority mapping is set for the element.

Parameters:

tagWorker - the tag worker

element - the element

context - the processor context

Returns:

the outline handler

setDestinationToElement

             protected OutlineHandler setDestinationToElement
             (ITagWorker tagWorker, com.itextpdf.styledxmlparser.node.IElementNode element)
            

Sets the destination to element. Sets the destination previously created in the addOutlineAndDestToDocument(com.itextpdf.html2pdf.attach.ITagWorker, com.itextpdf.styledxmlparser.node.IElementNode, com.itextpdf.html2pdf.attach.ProcessorContext) method to the tag worker element.

Parameters:

tagWorker - the tag worker

element - the element

Returns:

the outline handler