Top Inners Fields Constructors Methods
com.openhtmltopdf.render.displaylist

public Class DisplayListCollector

extends Object
Class Inheritance
Imports
java.awt.Rectangle, java.util.ArrayList, .Collections, .EnumSet, .HashMap, .HashSet, .List, .Map, .Set, com.openhtmltopdf.layout.CollapsedBorderSide, .Layer, com.openhtmltopdf.newtable.CollapsedBorderValue, .TableBox, .TableCellBox, com.openhtmltopdf.render.BlockBox, .Box, .PageBox, .RenderingContext, com.openhtmltopdf.render.displaylist.DisplayListContainer.DisplayListPageContainer, .PagedBoxCollector.PageInfo, .PagedBoxCollector.PageResult

Nested and Inner Type Summary

Modifier and TypeClass and Description
protected static enum
DisplayListCollector.CollectFlags

Field Summary

Modifier and TypeField and Description
private final List<PageBox>
_pages

Constructor Summary

AccessConstructor and Description
public
DisplayListCollector(List<PageBox> pages)

Method Summary

Modifier and TypeMethod and Description
protected void
addItem(DisplayListOperation item, int pgStart, int pgEnd, DisplayListContainer dlPages)

Adds a paint operation to a selection of pages, from pgStart to pgEnd inclusive.

protected void
addItem(DisplayListOperation item, List<PagedBoxCollector.PageInfo> pages, DisplayListContainer dlPages)

protected void
addTransformItem(Box master, List<PagedBoxCollector.PageInfo> pages, DisplayListContainer dlPages)

protected void
collect(RenderingContext c, Layer layer, DisplayListContainer dlPages, Set<DisplayListCollector.CollectFlags> flags)

The main method to create a list of paint instruction for each page.

public static Map<TableCellBox, List<CollapsedBorderSide>>
collectCollapsedTableBorders(RenderingContext c, List<TableCellBox> tcells)

private void
collectFloatAsLayer(RenderingContext c, Layer layer, BlockBox floater, DisplayListContainer.DisplayListPageContainer pageInstructions, int pageNumber, int shadowPageNumber)

This method can be reached by two code paths: collectRoot -: collect -: processPage -: collectFloatAsLayer -: processPage collectRoot -: collect -: processShadowPages -: foreach(shadowPage) -: processPage -: collectFloatAsLayer -: processPage Therefore, it is important to be careful when expecting a base page or shadow page.

public DisplayListContainer.DisplayListPageContainer
collectInlineBlock(RenderingContext c, BlockBox bb, EnumSet<DisplayListCollector.CollectFlags> noneOf, int shadowPageNo)

private void
collectLayerBackgroundAndBorder(RenderingContext c, Layer layer, DisplayListContainer dlPages, int pgStart, int pgEnd)

private void
collectLayers(RenderingContext c, List<Layer> layers, DisplayListContainer dlPages, Set<DisplayListCollector.CollectFlags> flags)

private void
collectReplacedElementLayer(RenderingContext c, Layer layer, DisplayListContainer dlPages, int pgStart, int pgEnd)

public DisplayListContainer
collectRoot(RenderingContext c, Layer rootLayer)

Use this method to collect all boxes recursively into a list of paint instructions for each page.

protected PagedBoxCollector
createBoundedBoxCollector(int pgStart, int pgEnd)

protected int
findEndPage(RenderingContext c, Layer layer)

protected int
findStartPage(RenderingContext c, Layer layer)

protected void
processPage(RenderingContext c, Layer layer, PagedBoxCollector.PageResult pg, DisplayListContainer.DisplayListPageContainer dlPageList, boolean includeFloats, int pageNumber, int shadowPageNumber)

Convert a list of boxes to a list of paint instructions for a page.

private void
processShadowPages(RenderingContext c, Layer layer, int pageNumber, PagedBoxCollector.PageResult pg, DisplayListContainer.DisplayListPageContainer dlPageList, boolean includeFloats)

If we have cut-off boxes we have to process them as separate pages.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

_pagesback to summary
private final List<PageBox> _pages

Constructor Detail

DisplayListCollectorback to summary
public DisplayListCollector(List<PageBox> pages)

Method Detail

addItemback to summary
protected void addItem(DisplayListOperation item, int pgStart, int pgEnd, DisplayListContainer dlPages)

Adds a paint operation to a selection of pages, from pgStart to pgEnd inclusive.

addItemback to summary
protected void addItem(DisplayListOperation item, List<PagedBoxCollector.PageInfo> pages, DisplayListContainer dlPages)
addTransformItemback to summary
protected void addTransformItem(Box master, List<PagedBoxCollector.PageInfo> pages, DisplayListContainer dlPages)
collectback to summary
protected void collect(RenderingContext c, Layer layer, DisplayListContainer dlPages, Set<DisplayListCollector.CollectFlags> flags)

The main method to create a list of paint instruction for each page.

collectCollapsedTableBordersback to summary
public static Map<TableCellBox, List<CollapsedBorderSide>> collectCollapsedTableBorders(RenderingContext c, List<TableCellBox> tcells)
collectFloatAsLayerback to summary
private void collectFloatAsLayer(RenderingContext c, Layer layer, BlockBox floater, DisplayListContainer.DisplayListPageContainer pageInstructions, int pageNumber, int shadowPageNumber)

This method can be reached by two code paths: collectRoot -: collect -: processPage -: collectFloatAsLayer -: processPage collectRoot -: collect -: processShadowPages -: foreach(shadowPage) -: processPage -: collectFloatAsLayer -: processPage Therefore, it is important to be careful when expecting a base page or shadow page.

collectInlineBlockback to summary
public DisplayListContainer.DisplayListPageContainer collectInlineBlock(RenderingContext c, BlockBox bb, EnumSet<DisplayListCollector.CollectFlags> noneOf, int shadowPageNo)
collectLayerBackgroundAndBorderback to summary
private void collectLayerBackgroundAndBorder(RenderingContext c, Layer layer, DisplayListContainer dlPages, int pgStart, int pgEnd)
collectLayersback to summary
private void collectLayers(RenderingContext c, List<Layer> layers, DisplayListContainer dlPages, Set<DisplayListCollector.CollectFlags> flags)
collectReplacedElementLayerback to summary
private void collectReplacedElementLayer(RenderingContext c, Layer layer, DisplayListContainer dlPages, int pgStart, int pgEnd)
collectRootback to summary
public DisplayListContainer collectRoot(RenderingContext c, Layer rootLayer)

Use this method to collect all boxes recursively into a list of paint instructions for each page.

createBoundedBoxCollectorback to summary
protected PagedBoxCollector createBoundedBoxCollector(int pgStart, int pgEnd)
findEndPageback to summary
protected int findEndPage(RenderingContext c, Layer layer)
findStartPageback to summary
protected int findStartPage(RenderingContext c, Layer layer)
processPageback to summary
protected void processPage(RenderingContext c, Layer layer, PagedBoxCollector.PageResult pg, DisplayListContainer.DisplayListPageContainer dlPageList, boolean includeFloats, int pageNumber, int shadowPageNumber)

Convert a list of boxes to a list of paint instructions for a page.

processShadowPagesback to summary
private void processShadowPages(RenderingContext c, Layer layer, int pageNumber, PagedBoxCollector.PageResult pg, DisplayListContainer.DisplayListPageContainer dlPageList, boolean includeFloats)

If we have cut-off boxes we have to process them as separate pages.

com.openhtmltopdf.render.displaylist back to summary

protected final Enum DisplayListCollector.CollectFlags

extends Enum<DisplayListCollector.CollectFlags>
Class Inheritance

Constructor Summary

AccessConstructor and Description
private
CollectFlags()

Method Summary

Modifier and TypeMethod and Description
public static DisplayListCollector.CollectFlags
valueOf(String name)

public static DisplayListCollector.CollectFlags[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Constructor Detail

CollectFlagsback to summary
private CollectFlags()

Method Detail

valueOfback to summary
public static DisplayListCollector.CollectFlags valueOf(String name)
valuesback to summary
public static DisplayListCollector.CollectFlags[] values()