com.openhtmltopdf.layout.Layer

public 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 layed out after its containing block has completed layout).

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`AUTO`
`static int`	`NEGATIVE`
`static short`	`PAGED_MODE_PRINT`
`static short`	`PAGED_MODE_SCREEN`
`static int`	`POSITIVE`
`static int`	`ZERO`

Constructor Summary

Constructors

Constructor Description

Layer(Layer parent, Box master, CssContext c)
Creates a child layer.

Layer(Box master, CssContext c)
Creates the root layer.

Method Summary

Modifier and Type	Method	Description
`void`	`addChild(Layer layer)`
`void`	`addFloat(BlockBox floater, BlockFormattingContext bfc)`
`void`	`addPage(CssContext c)`
`void`	`addPageSequence(BlockBox start)`
`void`	`addRunningBlock(BlockBox block)`
`protected List<AffineTransform>`	`applyTranform(RenderingContext c, Box box)`	Deprecated.
`void`	`assignPagePaintingPositions(CssContext cssCtx, int mode, int additionalClearance)`
`void`	`assignPagePaintingPositions(CssContext cssCtx, short mode)`
`List<Layer>`	`collectLayers(int which)`	Called recusively to collect all descendant layers in a stacking context so they can be painted in correct order.
`boolean`	`containsFixedContent()`	Deprecated.
`static PageBox`	`createPageBox(CssContext c, String pseudoPage)`
`boolean`	`crossesPageBreak(LayoutContext c, int top, int bottom)`
`void`	`detach()`
`void`	`ensureHasPage(CssContext c, Box box)`
`Box`	`find(CssContext cssCtx, int absX, int absY, boolean findAnonymous)`	Deprecated.
`Layer`	`findRoot()`
`void`	`finish(LayoutContext c)`
`List<Layer>`	`getChildren()`	The resulting list should not be modified.
`AffineTransform`	`getCurrentTransformMatrix()`	The document coordinates current transform, this is cumulative from layer to child layer.
`Box`	`getEnd()`
`PageBox`	`getFirstPage(CssContext c, Box box)`
`List<BlockBox>`	`getFloats()`
`PageBox`	`getLastPage()`
`PageBox`	`getLastPage(CssContext c, Box box)`
`Box`	`getMaster()`
`int`	`getMaxPageWidth(CssContext cssCtx, int additionalClearance)`
`PageBox`	`getPage(CssContext c, int yOffset)`
`List<PageBox>`	`getPages()`
`Dimension`	`getPaintingDimension(LayoutContext c)`
`Layer`	`getParent()`
`int`	`getRelativePageCount(RenderingContext c)`
`int`	`getRelativePageNo(RenderingContext c)`
`int`	`getRelativePageNo(RenderingContext c, int absY)`
`BlockBox`	`getRunningBlock(String identifer, PageBox page, PageElementPosition which)`
`Box`	`getSelectionEnd()`
`int`	`getSelectionEndX()`
`int`	`getSelectionEndY()`
`Box`	`getSelectionStart()`
`int`	`getSelectionStartX()`
`int`	`getSelectionStartY()`
`List<Layer>`	`getSortedLayers(int which)`
`int`	`getZIndex()`
`boolean`	`hasFixedAncester()`
`boolean`	`hasLocalTransform()`
`boolean`	`isForDeletion()`
`boolean`	`isInline()`
`boolean`	`isLastPage(PageBox pageBox)`
`boolean`	`isRequiresLayout()`
`boolean`	`isRootLayer()`
`boolean`	`isStackingContext()`
`boolean`	`isZIndexAuto()`
`void`	`layoutPages(LayoutContext c)`
`void`	`paint(RenderingContext c)`	Deprecated.
`void`	`paintAsLayer(RenderingContext c, BlockBox startingPoint)`	Deprecated.
`void`	`positionChildren(LayoutContext c)`
`void`	`positionFixedLayer(RenderingContext c)`
`void`	`propagateCurrentTransformationMatrix(CssContext c)`	Recursively propagates the transformation matrix.
`void`	`removeFloat(BlockBox floater)`	FIXME: Only used when we reset a box, so trying to remove at sometime in the future.
`void`	`removeLastPage()`
`void`	`removeRunningBlock(BlockBox block)`
`void`	`setEnd(Box end)`
`void`	`setFixedBackground(boolean b)`	Deprecated.
`void`	`setForDeletion(boolean forDeletion)`
`void`	`setInline(boolean inline)`
`void`	`setPages(List<PageBox> pages)`
`void`	`setRequiresLayout(boolean requiresLayout)`
`void`	`setSelectionEnd(Box selectionEnd)`
`void`	`setSelectionEndX(int selectionEndX)`
`void`	`setSelectionEndY(int selectionEndY)`
`void`	`setSelectionStart(Box selectionStart)`
`void`	`setSelectionStartX(int selectionStartX)`
`void`	`setSelectionStartY(int selectionStartY)`
`void`	`setStackingContext(boolean stackingContext)`
`void`	`trimEmptyPages(CssContext c, int maxYHeight)`
`void`	`trimPageCount(int newPageCount)`

Methods inherited from class java.lang.Object

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

Field Details
- PAGED_MODE_SCREEN
  
  public static final short PAGED_MODE_SCREEN
  
  See Also:
  
  Constant Field Values
- PAGED_MODE_PRINT
  
  public static final short PAGED_MODE_PRINT
  
  See Also:
  
  Constant Field Values
- POSITIVE
  
  public static final int POSITIVE
  
  See Also:
  
  Constant Field Values
- ZERO
  
  public static final int ZERO
  
  See Also:
  
  Constant Field Values
- NEGATIVE
  
  public static final int NEGATIVE
  
  See Also:
  
  Constant Field Values
- AUTO
  
  public static final int AUTO
  
  See Also:
  
  Constant Field Values
Constructor Details
- Layer
  
  public Layer(Box master, CssContext c)
  
  Creates the root layer.
- Layer
  
  public Layer(Layer parent, Box master, CssContext c)
  
  Creates a child layer.
Method Details
- propagateCurrentTransformationMatrix
  
  public void propagateCurrentTransformationMatrix(CssContext c)
  
  Recursively propagates the transformation matrix. This must be done after layout of the master box and its children as this method relies on the box width and height for relative units in the transforms and transform origins.
- getCurrentTransformMatrix
  
  public AffineTransform getCurrentTransformMatrix()
  
  The document coordinates current transform, this is cumulative from layer to child layer. May be null, if identity transform is in effect. Used to check if a box belonging to this layer sits on a particular page after the transform is applied. This method can only be used after propagateCurrentTransformationMatrix(CssContext) has been called on the root layer.
  
  Returns:
  
  null or affine transform.
- hasLocalTransform
  
  public boolean hasLocalTransform()
- setForDeletion
  
  public void setForDeletion(boolean forDeletion)
- isForDeletion
  
  public boolean isForDeletion()
- hasFixedAncester
  
  public boolean hasFixedAncester()
- getParent
  
  public Layer getParent()
- isStackingContext
  
  public boolean isStackingContext()
- setStackingContext
  
  public void setStackingContext(boolean stackingContext)
- getZIndex
  
  public int getZIndex()
- isZIndexAuto
  
  public boolean isZIndexAuto()
- getMaster
  
  public Box getMaster()
- addChild
  
  public void addChild(Layer layer)
- createPageBox
  
  public static PageBox createPageBox(CssContext c, String pseudoPage)
- removeFloat
  
  public void removeFloat(BlockBox floater)
  
  FIXME: Only used when we reset a box, so trying to remove at sometime in the future.
- addFloat
  
  public void addFloat(BlockBox floater, BlockFormattingContext bfc)
- collectLayers
  
  public List<Layer> collectLayers(int which)
  
  Called recusively to collect all descendant layers in a stacking context so they can be painted in correct order. Those descendants that are under their own stacking contexts are excluded.
  
  Parameters:
  
  which - NEGATIVE ZERO POSITIVE AUTO corresponding to z-index property.
  
  Returns:
- getSortedLayers
  
  public List<Layer> getSortedLayers(int which)
- getPaintingDimension
  
  public Dimension getPaintingDimension(LayoutContext c)
- paint
  
  @Deprecated public void paint(RenderingContext c)
  
  Deprecated.
- getFloats
  
  public List<BlockBox> getFloats()
- applyTranform
  
  @Deprecated protected List<AffineTransform> applyTranform(RenderingContext c, Box box)
  
  Deprecated.
  
  Applies the transforms specified for the box and returns a list of inverse transforms that should be applied once the transformed element has been output.
- find
  
  @Deprecated public Box find(CssContext cssCtx, int absX, int absY, boolean findAnonymous)
  
  Deprecated.
- paintAsLayer
  
  @Deprecated public void paintAsLayer(RenderingContext c, BlockBox startingPoint)
  
  Deprecated.
- positionFixedLayer
  
  public void positionFixedLayer(RenderingContext c)
- isRootLayer
  
  public boolean isRootLayer()
- positionChildren
  
  public void positionChildren(LayoutContext c)
- containsFixedContent
  
  @Deprecated public boolean containsFixedContent()
  
  Deprecated.
- setFixedBackground
  
  @Deprecated public void setFixedBackground(boolean b)
  
  Deprecated.
- getChildren
  
  public List<Layer> getChildren()
  
  The resulting list should not be modified.
- detach
  
  public void detach()
- isInline
  
  public boolean isInline()
- setInline
  
  public void setInline(boolean inline)
- getEnd
  
  public Box getEnd()
- setEnd
  
  public void setEnd(Box end)
- isRequiresLayout
  
  public boolean isRequiresLayout()
- setRequiresLayout
  
  public void setRequiresLayout(boolean requiresLayout)
- finish
  
  public void finish(LayoutContext c)
- getPages
  
  public List<PageBox> getPages()
- setPages
  
  public void setPages(List<PageBox> pages)
- isLastPage
  
  public boolean isLastPage(PageBox pageBox)
- removeLastPage
  
  public void removeLastPage()
- addPage
  
  public void addPage(CssContext c)
- getFirstPage
  
  public PageBox getFirstPage(CssContext c, Box box)
- getLastPage
  
  public PageBox getLastPage(CssContext c, Box box)
- ensureHasPage
  
  public void ensureHasPage(CssContext c, Box box)
- getPage
  
  public PageBox getPage(CssContext c, int yOffset)
- trimEmptyPages
  
  public void trimEmptyPages(CssContext c, int maxYHeight)
- trimPageCount
  
  public void trimPageCount(int newPageCount)
- assignPagePaintingPositions
  
  public void assignPagePaintingPositions(CssContext cssCtx, short mode)
- assignPagePaintingPositions
  
  public void assignPagePaintingPositions(CssContext cssCtx, int mode, int additionalClearance)
- getMaxPageWidth
  
  public int getMaxPageWidth(CssContext cssCtx, int additionalClearance)
- getLastPage
  
  public PageBox getLastPage()
- crossesPageBreak
  
  public boolean crossesPageBreak(LayoutContext c, int top, int bottom)
- findRoot
  
  public Layer findRoot()
- addRunningBlock
  
  public void addRunningBlock(BlockBox block)
- removeRunningBlock
  
  public void removeRunningBlock(BlockBox block)
- getRunningBlock
  
  public BlockBox getRunningBlock(String identifer, PageBox page, PageElementPosition which)
- layoutPages
  
  public void layoutPages(LayoutContext c)
- addPageSequence
  
  public void addPageSequence(BlockBox start)
- getRelativePageNo
  
  public int getRelativePageNo(RenderingContext c, int absY)
- getRelativePageNo
  
  public int getRelativePageNo(RenderingContext c)
- getRelativePageCount
  
  public int getRelativePageCount(RenderingContext c)
- getSelectionEnd
  
  public Box getSelectionEnd()
- setSelectionEnd
  
  public void setSelectionEnd(Box selectionEnd)
- getSelectionStart
  
  public Box getSelectionStart()
- setSelectionStart
  
  public void setSelectionStart(Box selectionStart)
- getSelectionEndX
  
  public int getSelectionEndX()
- setSelectionEndX
  
  public void setSelectionEndX(int selectionEndX)
- getSelectionEndY
  
  public int getSelectionEndY()
- setSelectionEndY
  
  public void setSelectionEndY(int selectionEndY)
- getSelectionStartX
  
  public int getSelectionStartX()
- setSelectionStartX
  
  public void setSelectionStartX(int selectionStartX)
- getSelectionStartY
  
  public int getSelectionStartY()
- setSelectionStartY
  
  public void setSelectionStartY(int selectionStartY)

Constructor	Description
`Layer(Layer parent, Box master, CssContext c)`	Creates a child layer.
`Layer(Box master, CssContext c)`	Creates the root layer.

Class Layer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details