Openhtmltopdf 1.0.10 · com.openhtmltopdf.render.PageBox

Modifier and Type	Class and Description
private static class	PageBox.BottomLeftCorner
private static class	PageBox.BottomMarginArea
private static class	PageBox.BottomRightCorner
private static class	PageBox.LeftMarginArea
private abstract static class	PageBox.MarginArea
private static class	PageBox.MarginAreaContainer
private static class	PageBox.PageDimensions
private static class	PageBox.RightMarginArea
private static class	PageBox.TopLeftCorner
private static class	PageBox.TopMarginArea
private static class	PageBox.TopRightCorner

Modifier and Type	Field and Description
private int	_basePagePdfPageIndex
private int	_bottom
private PageBox.MarginAreaContainer[]	_marginAreas
private Element	_metadata
private int	_outerPageWidth
private PageBox.PageDimensions	_pageDimensions
private PageInfo	_pageInfo
private int	_pageNo
private int	_paintingBottom
private int	_paintingTop
private int	_shadowPageCount
private CalculatedStyle	_style
private int	_top
private int	_totalFootnoteHeight
private PageBox.MarginAreaContainer	currentMarginAreaContainer
private static final int	LEADING_TRAILING_SPLIT
private static final PageBox.MarginArea[]	MARGIN_AREA_DEFS

Access	Constructor and Description
public	PageBox()

Method Summary

Modifier and Type	Method and Description
public void	exportLeadingText(RenderingContext c, Writer writer)
public void	exportTrailingText(RenderingContext c, Writer writer)
public int	getBasePagePdfPageIndex()
private Rectangle	getBorderEdge(int left, int top, CssContext cssCtx)
public int	getBottom() Gets the document Y position in top down units (20 per CSS pixel for PDF) Example: If each page is 500px high and has a 50px margin, then if this is called on the second page it will return 16_000, which is 2 x 400px x 20.
public int	getBottom(CssContext c) If we are in a footnote calls `getBottom()`, otherwise uses `getBottomUsable()`.
public int	getBottomUsable() Gets the document Y position taking into account `float: bottom` content such as footnotes.
public int	getContentHeight(CssContext cssCtx)
public int	getContentWidth(CssContext cssCtx)
public MarginBoxName[]	getCurrentMarginBoxNames()
public IdentValue	Returns: Either ltr (should insert cut-off content to the right of the page) or rtl (should insert cut-off content to the left of the page). getCutOffPageDirection()
public Rectangle	getDocumentCoordinatesContentBounds(CssContext c) Get the rectangle that this page's content area will cover of the layed out document.
public Rectangle	getDocumentCoordinatesContentBoundsForInsertedPage(CssContext c, int shadowPageNumber) Get the shadow page (a page inserted to carry cut off content) content area of the layed out document.
public int	getFootnoteAreaHeight() See `setFootnoteAreaHeight(int)`
public float	getFootnoteMaxHeight(CssContext c) Gets the footnote area max-height if it is provided in the footnote at-rule for this page, otherwise -1.
public int	getHeight(CssContext cssCtx)
public RectPropertySet	getMargin(CssContext cssCtx)
public int	getMarginBorderPadding(CssContext cssCtx, int which)
public int	getMaxInsertedPages() The maximum number of shadow pages to insert for cut-off content.
public int	getMaxShadowPagesForXPos(CssContext c, int x) Returns the number of shadow pages needed for a given x coordinate.
public Element	getMetadata()
public int	getOuterPageWidth()
public Rectangle	getPagedViewClippingBounds(CssContext cssCtx, int additionalClearance)
public PageInfo	getPageInfo()
public int	getPageNo()
public int	getPaintingBottom()
public int	Returns: the y index into the document coordinates. getPaintingTop() Example: If a page is 100 units high and has a 10 unit margin, this will return 0 for the first page and 80 for the second and so on.
public Rectangle	getPrintClippingBounds(CssContext cssCtx)
public Rectangle	getPrintPaintingBounds(CssContext cssCtx)
public Rectangle	getScreenPaintingBounds(CssContext cssCtx, int additionalClearance)
public int	getShadowPageCount()
public CalculatedStyle	getStyle()
public int	getTop() Get the document Y index into this page.
public int	getWidth(CssContext cssCtx)
public boolean	isFootnoteReserved(CssContext c) If this page is reserved for footnote content.
public boolean	isLeftPage()
public boolean	isRightPage()
public void	layout(LayoutContext c)
private void	layoutMarginAreas(LayoutContext c)
public void	paintBackground(RenderingContext c, int additionalClearance, short mode)
public void	paintBorder(RenderingContext c, int additionalClearance, short mode)
public void	paintMarginAreas(RenderingContext c, int additionalClearance, short mode)
private int	resolveAutoPageHeight(CssContext cssCtx) Return the default page height if defined, else A4.
private int	resolveAutoPageWidth(CssContext cssCtx) Returns the default page width if defined, else the A4 page size width Note We previously returned different sizes based on locale, but this could lead to different results between developement machines and servers so we now always return A4.
private void	resolvePageDimensions(CssContext cssCtx)
private void	retrievePageMetadata(LayoutContext c)
public void	setBasePagePdfPageIndex(int idx)
public void	setFootnoteAreaHeight(int footnoteAreaHeight) Sets the footnote area height on this page.
public void	setOuterPageWidth(int containingBlockWidth)
public void	setPageInfo(PageInfo pageInfo)
public void	setPageNo(int pageNo)
public void	setPaintingBottom(int paintingBottom)
public void	setPaintingTop(int paintingTop)
public void	setShadowPageCount(int cnt)
public void	setStyle(CalculatedStyle style)
public void	setTopAndBottom(CssContext cssCtx, int top)
public boolean	shouldInsertPages() Should shadow pages be inserted for cut off content for this page.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

public Class PageBox

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary