Openhtmltopdf 1.0.10 · com.openhtmltopdf.render.RenderingContext

Modifier and Type	Field and Description
private BidiReorderer	_bidi
private boolean	_isInFloatBottom
private FontContext	fontContext
private int	initialPageNo
private boolean	inPageMargins
private boolean	isFastRenderer
private OutputDevice	outputDevice
private PageBox	page
private int	pageCount
private int	pageNo
private Layer	rootLayer
private int	shadowPageNumber
protected final SharedContext	sharedContext

Access	Constructor and Description
public	RenderingContext(SharedContext sharedContext) needs a new instance every run

Method Summary

Modifier and Type	Method and Description
public Object	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public boolean	debugDrawBoxes()
public boolean	debugDrawFontMetrics()
public boolean	debugDrawInlineBoxes()
public boolean	debugDrawLineBoxes()
public String	getBaseURL()
public BidiReorderer	getBidiReorderer()
public Box	getBoxById(String id)
public FSCanvas	getCanvas()
public StyleReference	getCss() Implements com.openhtmltopdf.css.style.CssContext.getCss.
public int	getDotsPerPixel() Implements com.openhtmltopdf.css.style.CssContext.getDotsPerPixel.
public float	getDPI()
public Rectangle	getFixedRectangle(boolean excludeFloatBottomArea) Get the document (for non-paged docs) or page rect where fixed position boxes should be layed out.
public FSFont	getFont(FontSpecification font) Implements com.openhtmltopdf.css.style.CssContext.getFont.
public FontContext	getFontContext() Implements com.openhtmltopdf.css.style.CssContext.getFontContext.
public FontResolver	getFontResolver()
public float	getFontSize2D(FontSpecification font) Implements com.openhtmltopdf.css.style.CssContext.getFontSize2D.
public FSFontMetrics	getFSFontMetrics(FSFont font) Implements com.openhtmltopdf.css.style.CssContext.getFSFontMetrics.
public int	getInitialPageNo()
public float	getMmPerDot() Implements com.openhtmltopdf.css.style.CssContext.getMmPerDot.
public OutputDevice	getOutputDevice()
public PageBox	getPage()
public int	getPageCount()
public int	getPageNo()
public Layer	getRootLayer()
public int	Returns: overflow page number or -1 if this is not an overflow page. getShadowPageNumber()
public TextRenderer	getTextRenderer() Implements com.openhtmltopdf.css.style.CssContext.getTextRenderer.
public UserAgentCallback	getUac()
public Rectangle	getViewportRectangle() Get the viewport rect, for painting the body or html tag background.
public float	getXHeight(FontSpecification parentFont) Implements com.openhtmltopdf.css.style.CssContext.getXHeight.
public boolean	isFastRenderer()
public boolean	isInFloatBottom() Implements com.openhtmltopdf.css.style.CssContext.isInFloatBottom. Returns true if we are laying out the footnote area rather than general content.
public boolean	isInPageMargins()
public boolean	isInteractive()
public boolean	Returns: The paged value isPaged() Returns true if the currently set media type is paged.
public boolean	isPrint()
public void	setBaseURL(String url)
public void	setBidiReorderer(BidiReorderer bidi)
public void	setFastRenderer(boolean isFast)
public void	setFontContext(FontContext fontContext)
public void	setInitialPageNo(int initialPageNo)
public void	setInPageMargins(boolean inMargin)
public void	setIsInFloatBottom(boolean inFloatBottom) See `isInFloatBottom()`
public void	setOutputDevice(OutputDevice outputDevice)
public void	setPage(int pageNo, PageBox page)
public void	setPageCount(int pageCount)
public void	setRootLayer(Layer rootLayer)
public void	setShadowPageNumber(int shadow)

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

_bidi	back to summary
private BidiReorderer _bidi

_isInFloatBottom	back to summary
private boolean _isInFloatBottom

fontContext	back to summary
private FontContext fontContext

initialPageNo	back to summary
private int initialPageNo

inPageMargins	back to summary
private boolean inPageMargins

isFastRenderer	back to summary
private boolean isFastRenderer

outputDevice	back to summary
private OutputDevice outputDevice

page	back to summary
private PageBox page

pageCount	back to summary
private int pageCount

pageNo	back to summary
private int pageNo

rootLayer	back to summary
private Layer rootLayer

shadowPageNumber	back to summary
private int shadowPageNumber

sharedContext	back to summary
protected final SharedContext sharedContext

RenderingContext	back to summary
public RenderingContext(SharedContext sharedContext) needs a new instance every run

Method Detail

clone back to summary

clone	back to summary
public Object clone() Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:Object a clone of this instance. Annotations @Override

public Object clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:Object

a clone of this instance.

Annotations

@Override

debugDrawBoxes	back to summary
public boolean debugDrawBoxes()

debugDrawFontMetrics	back to summary
public boolean debugDrawFontMetrics()

debugDrawInlineBoxes	back to summary
public boolean debugDrawInlineBoxes()

debugDrawLineBoxes	back to summary
public boolean debugDrawLineBoxes()

getBaseURL	back to summary
public String getBaseURL()

getBidiReorderer	back to summary
public BidiReorderer getBidiReorderer()

getBoxById	back to summary
public Box getBoxById(String id)

getCanvas	back to summary
public FSCanvas getCanvas()

getCss	back to summary
public StyleReference getCss() Implements com.openhtmltopdf.css.style.CssContext.getCss.

getDotsPerPixel	back to summary
public int getDotsPerPixel() Implements com.openhtmltopdf.css.style.CssContext.getDotsPerPixel.

getDPI	back to summary
public float getDPI()

getFixedRectangle	back to summary
public Rectangle getFixedRectangle(boolean excludeFloatBottomArea) Get the document (for non-paged docs) or page rect where fixed position boxes should be layed out. Generally we want to set `excludeFloatBottomArea` true so fixed content doesn't sit above footnotes.

getFont	back to summary
public FSFont getFont(FontSpecification font) Implements com.openhtmltopdf.css.style.CssContext.getFont.

getFontContext	back to summary
public FontContext getFontContext() Implements com.openhtmltopdf.css.style.CssContext.getFontContext. Annotations @Override

getFontContext

back to summary

public FontContext getFontContext()

Implements com.openhtmltopdf.css.style.CssContext.getFontContext.

Annotations

@Override

getFontResolver	back to summary
public FontResolver getFontResolver()

getFontSize2D	back to summary
public float getFontSize2D(FontSpecification font) Implements com.openhtmltopdf.css.style.CssContext.getFontSize2D.

getFSFontMetrics	back to summary
public FSFontMetrics getFSFontMetrics(FSFont font) Implements com.openhtmltopdf.css.style.CssContext.getFSFontMetrics.

getInitialPageNo	back to summary
public int getInitialPageNo()

getMmPerDot	back to summary
public float getMmPerDot() Implements com.openhtmltopdf.css.style.CssContext.getMmPerDot.

getOutputDevice	back to summary
public OutputDevice getOutputDevice()

getPage	back to summary
public PageBox getPage()

getPageCount	back to summary
public int getPageCount()

getPageNo	back to summary
public int getPageNo()

getRootLayer	back to summary
public Layer getRootLayer()

getShadowPageNumber	back to summary
public int getShadowPageNumber() Returns:int overflow page number or -1 if this is not an overflow page.

getTextRenderer	back to summary
public TextRenderer getTextRenderer() Implements com.openhtmltopdf.css.style.CssContext.getTextRenderer. Annotations @Override

getTextRenderer

back to summary

public TextRenderer getTextRenderer()

Implements com.openhtmltopdf.css.style.CssContext.getTextRenderer.

Annotations

@Override

getUac	back to summary
public UserAgentCallback getUac()

getViewportRectangle	back to summary
public Rectangle getViewportRectangle() Get the viewport rect, for painting the body or html tag background.

getXHeight	back to summary
public float getXHeight(FontSpecification parentFont) Implements com.openhtmltopdf.css.style.CssContext.getXHeight.

isFastRenderer	back to summary
public boolean isFastRenderer()

isInFloatBottom	back to summary
public boolean isInFloatBottom() Implements com.openhtmltopdf.css.style.CssContext.isInFloatBottom. Doc from com.openhtmltopdf.css.style.CssContext.isInFloatBottom. Returns true if we are laying out the footnote area rather than general content.

isInFloatBottom

back to summary

public boolean isInFloatBottom()

Implements com.openhtmltopdf.css.style.CssContext.isInFloatBottom.

Doc from com.openhtmltopdf.css.style.CssContext.isInFloatBottom.

Returns true if we are laying out the footnote area rather than general content.

isInPageMargins	back to summary
public boolean isInPageMargins()

isInteractive	back to summary
public boolean isInteractive()

isPaged

back to summary

public boolean isPaged()

Returns true if the currently set media type is paged. Currently returns true only for print , projection , and embossed , handheld , and tv . See the media section of the CSS 2.1 spec for more information on media types.

Returns:boolean: The paged value

isPrint	back to summary
public boolean isPrint()

setBaseURL	back to summary
public void setBaseURL(String url)

setBidiReorderer	back to summary
public void setBidiReorderer(BidiReorderer bidi)

setFastRenderer	back to summary
public void setFastRenderer(boolean isFast)

setFontContext	back to summary
public void setFontContext(FontContext fontContext)

setInitialPageNo	back to summary
public void setInitialPageNo(int initialPageNo)

setInPageMargins	back to summary
public void setInPageMargins(boolean inMargin)

setIsInFloatBottom	back to summary
public void setIsInFloatBottom(boolean inFloatBottom) See `isInFloatBottom()`

setOutputDevice	back to summary
public void setOutputDevice(OutputDevice outputDevice)

setPage	back to summary
public void setPage(int pageNo, PageBox page)

setPageCount	back to summary
public void setPageCount(int pageCount)

setRootLayer	back to summary
public void setRootLayer(Layer rootLayer)

setShadowPageNumber	back to summary
public void setShadowPageNumber(int shadow)

public Class RenderingContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail