Class Layer

java.lang.Object
org.openpdf.layout.Layer
public final class Layer extends Object
All positioned content as well as content with an overflow value other than visible creates a layer. Layers which define stacking contexts provide the entry for rendering the box tree to an output device. The main purpose of this class is to provide an implementation of Appendix E of the spec, but it also provides additional utility services including page management and mapping boxes to coordinates (for e.g. links). When rendering to a paged output device, the layer is also responsible for laying out absolute content (which is laid out after its containing block has completed layout).

  • Field Details

    • _parent

      private final @Nullable Layer _parent

    • _stackingContext

      private final boolean _stackingContext

    • _children

      private @Nullable List<Layer> _children

    • _master

      private final Box _master

    • _end

      private @Nullable Box _end

    • _floats

      private @Nullable List<BlockBox> _floats

    • _fixedBackground

      private boolean _fixedBackground

    • _inline

      private boolean _inline

    • _requiresLayout

      private boolean _requiresLayout

    • _pages

      private final List<PageBox> _pages

    • _lastRequestedPage

      private @Nullable PageBox _lastRequestedPage

    • _pageSequences

      private @Nullable Set<BlockBox> _pageSequences

    • _sortedPageSequences

      private @Nullable List<BlockBox> _sortedPageSequences

    • _runningBlocks

      private @Nullable Map<String, List<BlockBox>> _runningBlocks

  • Constructor Details

    • Layer

      public Layer(Box master)

    • Layer

      public Layer(@Nullable Layer parent, Box master)

    • Layer

      Layer(@Nullable Layer parent, Box master, boolean stackingContext)

  • Method Details

    • getParent

      @CheckReturnValue public @Nullable Layer getParent()

    • isStackingContext

      @CheckReturnValue public boolean isStackingContext()

    • getZIndex

      @CheckReturnValue public int getZIndex()

    • getOpacity

      public float getOpacity()

    • getMaster

      @CheckReturnValue public Box getMaster()

    • addChild

      public void addChild(Layer layer)

    • addFloat

      public void addFloat(BlockBox floater)

    • removeFloat

      public void removeFloat(BlockBox floater)

    • paintFloats

      private void paintFloats(RenderingContext c)

    • paintLayers

      private void paintLayers(RenderingContext c, List<Layer> layers)

    • collectLayers

      @CheckReturnValue private List<Layer> collectLayers(Layer.Width which)

    • getStackingContextLayers

      @CheckReturnValue private List<Layer> getStackingContextLayers(Layer.Width which)

    • getSortedLayers

      @CheckReturnValue private List<Layer> getSortedLayers(Layer.Width which)

    • paintBackgroundsAndBorders

      private void paintBackgroundsAndBorders(RenderingContext c, List<Box> blocks, @Nullable Map<TableCellBox, List<CollapsedBorderSide>> collapsedTableBorders, BoxRangeLists rangeLists)

    • paintInlineContent

      private void paintInlineContent(RenderingContext c, List<Box> lines, BoxRangeLists rangeLists)

    • paintSelection

      private void paintSelection(RenderingContext c, List<Box> lines)

    • getPaintingDimension

      @CheckReturnValue public Dimension getPaintingDimension(LayoutContext c)

    • paint

      public void paint(RenderingContext c)

    • getFloats

      @CheckReturnValue private List<BlockBox> getFloats()

    • find

      @CheckReturnValue public @Nullable Box find(CssContext cssCtx, int absX, int absY, boolean findAnonymous)

    • find

      @CheckReturnValue private @Nullable Box find(CssContext cssCtx, int absX, int absY, List<Layer> layers, boolean findAnonymous)

    • collectCollapsedTableBorders

      @CheckReturnValue private @Nullable Map<TableCellBox, List<CollapsedBorderSide>> collectCollapsedTableBorders(List<Box> blocks)

    • paintCollapsedTableBorders

      private void paintCollapsedTableBorders(RenderingContext c, List<CollapsedBorderSide> borders)

    • paintAsLayer

      public void paintAsLayer(RenderingContext c, BlockBox startingPoint)

    • paintListMarkers

      private void paintListMarkers(RenderingContext c, List<Box> blocks, BoxRangeLists rangeLists)

    • paintReplacedElements

      private void paintReplacedElements(RenderingContext c, List<Box> blocks, BoxRangeLists rangeLists)

    • positionFixedLayer

      private void positionFixedLayer(RenderingContext c)

    • paintLayerBackgroundAndBorder

      private void paintLayerBackgroundAndBorder(RenderingContext c)

    • paintReplacedElement

      private void paintReplacedElement(RenderingContext c, BlockBox replaced)

    • isRootLayer

      public boolean isRootLayer()

    • moveIfGreater

      private void moveIfGreater(Dimension result, Dimension test)

    • calcPaintingDimension

      @CheckReturnValue private PaintingInfo calcPaintingDimension(LayoutContext c)

    • positionChildren

      public void positionChildren(LayoutContext c)

    • position

      private void position(LayoutContext c)

    • containsFixedLayer

      @CheckReturnValue private boolean containsFixedLayer()

    • containsFixedContent

      @CheckReturnValue public boolean containsFixedContent()

    • setFixedBackground

      public void setFixedBackground(boolean b)

    • getChildren

      @CheckReturnValue public List<Layer> getChildren()

    • remove

      private void remove(Layer layer)

    • detach

      public void detach()

    • isInline

      @CheckReturnValue public boolean isInline()

    • setInline

      public void setInline(boolean inline)

    • getEnd

      @CheckReturnValue public @Nullable Box getEnd()

    • setEnd

      public void setEnd(Box end)

    • isRequiresLayout

      @CheckReturnValue public boolean isRequiresLayout()

    • setRequiresLayout

      public void setRequiresLayout(boolean requiresLayout)

    • finish

      public void finish(LayoutContext c)

    • layoutAbsoluteChildren

      private void layoutAbsoluteChildren(LayoutContext c)

    • layoutAbsoluteChild

      private void layoutAbsoluteChild(LayoutContext c, Layer child)

    • getPages

      @CheckReturnValue public List<PageBox> getPages()

    • isLastPage

      public boolean isLastPage(PageBox pageBox)

    • addPage

      public void addPage(CssContext c)

    • pseudoPage

      private static String pseudoPage(int size)

    • removeLastPage

      public void removeLastPage()

    • createPageBox

      @CheckReturnValue public static PageBox createPageBox(CssContext c, String pseudoPage)

    • createPageBox

      @CheckReturnValue public static PageBox createPageBox(CssContext c, String pseudoPage, int top, int pageNo)

    • getFirstPage

      @CheckReturnValue public @Nullable PageBox getFirstPage(CssContext c, Box box)

    • getLastPage

      @CanIgnoreReturnValue public @Nullable PageBox getLastPage(CssContext c, Box box)

    • ensureHasPage

      public void ensureHasPage(CssContext c, Box box)

    • getPage

      @CanIgnoreReturnValue public @Nullable PageBox getPage(CssContext c, int yOffset)

    • addPagesUntilPosition

      private void addPagesUntilPosition(CssContext c, int position)

    • trimEmptyPages

      public void trimEmptyPages(int maxYHeight)

    • trimPageCount

      public void trimPageCount(int newPageCount)

    • assignPagePaintingPositions

      public void assignPagePaintingPositions(CssContext cssCtx, Layer.PagedMode mode)

    • assignPagePaintingPositions

      public void assignPagePaintingPositions(CssContext cssCtx, Layer.PagedMode mode, int additionalClearance)

    • getMaxPageWidth

      public int getMaxPageWidth(CssContext cssCtx, int additionalClearance)

    • getLastPage

      public @Nullable PageBox getLastPage()

    • crossesPageBreak

      public boolean crossesPageBreak(LayoutContext c, int top, int bottom)

    • findRoot

      @CheckReturnValue public Layer findRoot()

    • addRunningBlock

      public void addRunningBlock(BlockBox block)

    • removeRunningBlock

      public void removeRunningBlock(BlockBox block)

    • getRunningBlock

      public @Nullable BlockBox getRunningBlock(String identifier, PageBox page, PageElementPosition which)

    • layoutPages

      public void layoutPages(LayoutContext c)

    • addPageSequence

      public void addPageSequence(BlockBox start)

    • getSortedPageSequences

      @CanIgnoreReturnValue private @Nullable List<BlockBox> getSortedPageSequences()

    • getRelativePageNo

      public int getRelativePageNo(RenderingContext c, int absY)

    • findPageSequence

      @CheckReturnValue private @Nullable BlockBox findPageSequence(List<BlockBox> sequences, int absY)

    • getRelativePageNo

      @CheckReturnValue public int getRelativePageNo(RenderingContext c)

    • getRelativePageCount

      @CheckReturnValue public int getRelativePageCount(RenderingContext c)

    • getPageSequenceStart

      @CheckReturnValue private int getPageSequenceStart(List<BlockBox> sequences, PageBox page)

    • getLastRequestedPage

      @CheckReturnValue private @Nullable PageBox getLastRequestedPage()

    • setLastRequestedPage

      private void setLastRequestedPage(@Nullable PageBox lastRequestedPage)