RenderingContext (Openhtmltopdf Core Renderer 1.1.24 API)

java.lang.Object
- com.openhtmltopdf.render.RenderingContext

All Implemented Interfaces:

CssContext, Cloneable
```
public class RenderingContext
extends Object
implements CssContext, Cloneable
```
Supplies information about the context in which rendering will take place

Author:

jmarinacci November 16, 2004

Field Summary

Fields
Modifier and Type Field and Description

protected SharedContext sharedContext

Fields
Modifier and Type	Field and Description
`protected SharedContext`	`sharedContext`

Constructor Summary

Constructors
Constructor and Description

RenderingContext(SharedContext sharedContext)
needs a new instance every run

Constructors
Constructor and Description
`RenderingContext(SharedContext sharedContext)` needs a new instance every run

Method Summary

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

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sharedContext

protected final SharedContext sharedContext

Constructor Detail
- RenderingContext
```
public RenderingContext(SharedContext sharedContext)
```
  needs a new instance every run

Method Detail

isFastRenderer
```
public boolean isFastRenderer()
```

setFastRenderer

public void setFastRenderer(boolean isFast)

setBaseURL
```
public void setBaseURL(String url)
```

getUac
```
public UserAgentCallback getUac()
```

getBaseURL
```
public String getBaseURL()
```

getDPI
```
public float getDPI()
```

getMmPerDot
```
public float getMmPerDot()
```
Specified by:

getMmPerDot in interface CssContext

getDotsPerPixel
```
public int getDotsPerPixel()
```
Specified by:

getDotsPerPixel in interface CssContext

getFontSize2D
```
public float getFontSize2D(FontSpecification font)
```
Specified by:

getFontSize2D in interface CssContext

getXHeight

public float getXHeight(FontSpecification parentFont)

Specified by:: getXHeight in interface CssContext

getTextRenderer
```
public TextRenderer getTextRenderer()
```
Specified by:

getTextRenderer in interface CssContext

setBidiReorderer

public void setBidiReorderer(BidiReorderer bidi)

getBidiReorderer

public BidiReorderer getBidiReorderer()

isPaged
```
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:

The paged value

getFontResolver
```
public FontResolver getFontResolver()
```

getFont

public FSFont getFont(FontSpecification font)

Specified by:: getFont in interface CssContext

getCanvas
```
public FSCanvas getCanvas()
```

getFixedRectangle
```
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.

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

debugDrawBoxes
```
public boolean debugDrawBoxes()
```

debugDrawLineBoxes
```
public boolean debugDrawLineBoxes()
```

debugDrawInlineBoxes
```
public boolean debugDrawInlineBoxes()
```

debugDrawFontMetrics
```
public boolean debugDrawFontMetrics()
```

isInteractive
```
public boolean isInteractive()
```

isPrint
```
public boolean isPrint()
```

getOutputDevice
```
public OutputDevice getOutputDevice()
```

setOutputDevice

public void setOutputDevice(OutputDevice outputDevice)

getFontContext
```
public FontContext getFontContext()
```
Specified by:

getFontContext in interface CssContext

setFontContext

public void setFontContext(FontContext fontContext)

setPage

public void setPage(int pageNo,
                    PageBox page)

getPageCount
```
public int getPageCount()
```

setPageCount

public void setPageCount(int pageCount)

getPage
```
public PageBox getPage()
```

getPageNo
```
public int getPageNo()
```

getCss
```
public StyleReference getCss()
```
Specified by:

getCss in interface CssContext

getFSFontMetrics
```
public FSFontMetrics getFSFontMetrics(FSFont font)
```
Specified by:

getFSFontMetrics in interface CssContext

getRootLayer
```
public Layer getRootLayer()
```

setRootLayer

public void setRootLayer(Layer rootLayer)

getInitialPageNo
```
public int getInitialPageNo()
```

setInitialPageNo

public void setInitialPageNo(int initialPageNo)

getBoxById
```
public Box getBoxById(String id)
```

setShadowPageNumber

public void setShadowPageNumber(int shadow)

getShadowPageNumber
```
public int getShadowPageNumber()
```
Returns:

overflow page number or -1 if this is not an overflow page.

setInPageMargins

public void setInPageMargins(boolean inMargin)

isInPageMargins
```
public boolean isInPageMargins()
```

clone
```
public Object clone()
```
Overrides:

clone in class Object

setIsInFloatBottom

public void setIsInFloatBottom(boolean inFloatBottom)

See isInFloatBottom()

isInFloatBottom
```
public boolean isInFloatBottom()
```
Returns true if we are laying out the footnote area rather than general content.

Specified by:

isInFloatBottom in interface CssContext

Class RenderingContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sharedContext

Constructor Detail

RenderingContext

Method Detail

isFastRenderer

setFastRenderer

setBaseURL

getUac

getBaseURL

getDPI

getMmPerDot

getDotsPerPixel

getFontSize2D

getXHeight

getTextRenderer

setBidiReorderer

getBidiReorderer

isPaged

getFontResolver

getFont

getCanvas

getFixedRectangle

getViewportRectangle

debugDrawBoxes

debugDrawLineBoxes

debugDrawInlineBoxes

debugDrawFontMetrics

isInteractive

isPrint

getOutputDevice

setOutputDevice

getFontContext

setFontContext

setPage

getPageCount

setPageCount

getPage

getPageNo

getCss

getFSFontMetrics

getRootLayer

setRootLayer

getInitialPageNo

setInitialPageNo

getBoxById

setShadowPageNumber

getShadowPageNumber

setInPageMargins

isInPageMargins

clone

setIsInFloatBottom

isInFloatBottom