Openhtmltopdf 1.0.10 · com.openhtmltopdf.layout.SharedContext

Field Summary

Modifier and Type	Field and Description
public String	_preferredDocumentBuilderFactoryImplementationClass
public String	_preferredTransformerFactoryImplementationClass
private final RootCounterContext	_rootCounterContext
private FSTextTransformer	_unicodeToLowerTransformer
private FSTextTransformer	_unicodeToTitleTransformer
private FSTextTransformer	_unicodeToUpperTransformer
protected FSCanvas	canvas
private FSTextBreaker	characterBreaker
private static final float	CM__PER__IN
protected StyleReference	css
protected boolean	debug_draw_boxes
protected boolean	debug_draw_font_metrics
protected boolean	debug_draw_inline_boxes
protected boolean	debug_draw_line_boxes
private static final int	DEFAULT_DOTS_PER_PIXEL Deprecated Belongs in Java2D renderer.
private static final float	DEFAULT_DPI Deprecated Belongs in Java2D renderer.
private static final boolean	DEFAULT_INTERACTIVE Deprecated Belongs in Java2D renderer.
private Float	defaultPageHeight
private boolean	defaultPageSizeIsInches
private Float	defaultPageWidth
private int	dotsPerPixel Internal program dots per pixel.
private float	dpi Used to adjust fonts, ems, points, into screen resolution.
protected FontResolver	fontResolver
private Map<String, Box>	idMap
private boolean	interactive
private FSTextBreaker	lineBreaker
private String	media
private static final int	MM__PER__CM
private float	mmPerDot dpi in a more usable way Internal program dots per mm (probably a fraction).
private NamespaceHandler	namespaceHandler
private boolean	print
private ReplacedElementFactory	replacedElementFactory
private String	replacementText
private final Map<Element, CalculatedStyle>	styleMap
private Rectangle	tempCanvas
private TextRenderer	textRenderer
private UserAgentCallback	uac

Constructor Summary

Access	Constructor and Description
public	SharedContext()

Method Summary

Modifier and Type	Method and Description
public void	addBoxId(String id, Box box)
public boolean	debugDrawBoxes()
public boolean	debugDrawFontMetrics()
public boolean	debugDrawInlineBoxes()
public boolean	debugDrawLineBoxes()
public String	Returns: The baseURL value getBaseURL() Gets the baseURL attribute of the RenderingContext object
public Box	getBoxById(String id)
public FSCanvas	getCanvas()
public FSTextBreaker	getCharacterBreaker()
public StyleReference	getCss()
public Float	Returns: default page height or null. getDefaultPageHeight() Stores a default page height.
public Float	Returns: default page width or null. getDefaultPageWidth() Stores a default page width.
public int	getDotsPerPixel() Get the internal dots measurement per CSS pixel.
public float	Returns: The dPI value getDPI() Gets the dPI attribute of the RenderingContext object
public Rectangle	getFixedRectangle()
public FSFont	getFont(FontSpecification spec)
public FontResolver	Returns: The fontResolver value getFontResolver() Gets the fontResolver attribute of the Context object
public RootCounterContext	getGlobalCounterContext()
public Map<String, Box>	getIdMap()
public FSTextBreaker	getLineBreaker()
public String	getMedia() The media for this context
public float	Returns: The dPI value getMmPerDotParent() Gets the dPI attribute in a more useful form of the RenderingContext object
public NamespaceHandler	getNamespaceHandler()
public ReplacedElementFactory	getReplacedElementFactory()
public String	Returns: the current replacement text, "#" by default getReplacementText() The replacement text to be used if a character cannot be renderered by the current or fallback fonts.
public CalculatedStyle	getStyle(Element e) Gets the resolved style for an element.
public TextRenderer	getTextRenderer()
public UserAgentCallback	Returns: The uac value (user agent). getUac() Deprecated Use getUserAgentCallback instead for clearer code. Gets the uac attribute of the RenderingContext object
public FSTextTransformer	getUnicodeToLowerTransformer()
public FSTextTransformer	getUnicodeToTitleTransformer()
public FSTextTransformer	getUnicodeToUpperTransformer()
public UserAgentCallback	getUserAgentCallback()
public float	getXHeight(FontContext fontContext, FontSpecification fs)
public boolean	Returns: true if the page size is in inches, false if it is in mm. isDefaultPageSizeInches() If not, consider it as mm.
public boolean	isInteractive()
public boolean	Returns: The paged value isPaged() Returns true if the currently set media type is paged.
public boolean	isPrint()
public LayoutContext	newLayoutContextInstance()
public RenderingContext	newRenderingContextInstance()
public void	registerWithThread() This registers the shared context with a thread local so it can be used anywhere.
public void	removeBoxId(String id)
public void	removeFromThread() This removes the shared context from a thread local to avoid memory leaks.
public void	setBaseURL(String The new baseURL value url) Sets the baseURL attribute of the RenderingContext object
public void	setCanvas(FSCanvas canvas)
public void	setCharacterBreaker(FSTextBreaker breaker)
public void	setCss(StyleReference css)
public void	setDebug_draw_boxes(boolean debug_draw_boxes)
public void	setDebug_draw_font_metrics(boolean debug_draw_font_metrics)
public void	setDebug_draw_inline_boxes(boolean debug_draw_inline_boxes)
public void	setDebug_draw_line_boxes(boolean debug_draw_line_boxes)
public void	setDefaultPageSize(Float pageWidth, Float pageHeight, boolean isInches) Set the default page dimensions.
public void	setDotsPerPixel(int dotsPerPixel) Set the internal dots measurement per CSS pixel.
public void	setDPI(float The new dPI value dpi) Sets the effective DPI (Dots Per Inch) of the screen.
public void	setFontMapping(String The new font name name, Font The actual Font to map font) Deprecated Definitely shouldn't use this method as it only applies for Java2D font resolver. Instead call getFontResolver, cast and use font adding methods on that. Adds or overrides a font mapping, meaning you can associate a particular font with a particular string.
public void	setFontResolver(FontResolver resolver)
public void	setInteractive(boolean interactive)
public void	setLineBreaker(FSTextBreaker breaker)
public void	setMedia(String The new media value media) Set the current media type.
public void	setNamespaceHandler(NamespaceHandler nh)
public void	setPrint(boolean print)
public void	setReplacedElementFactory(ReplacedElementFactory ref)
public void	setReplacementText(String replacement)
public void	setTempCanvas(Rectangle rect)
public void	setTextRenderer(TextRenderer The new textRenderer value textRenderer) Sets the textRenderer attribute of the RenderingContext object
public void	setUnicodeToLowerTransformer(FSTextTransformer tr)
public void	setUnicodeToTitleTransformer(FSTextTransformer tr)
public void	setUnicodeToUpperTransformer(FSTextTransformer tr)
public void	setUserAgentCallback(UserAgentCallback userAgentCallback)

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

Field Detail

_preferredDocumentBuilderFactoryImplementationClass	back to summary
public String _preferredDocumentBuilderFactoryImplementationClass

_preferredTransformerFactoryImplementationClass	back to summary
public String _preferredTransformerFactoryImplementationClass

_rootCounterContext	back to summary
private final RootCounterContext _rootCounterContext

_unicodeToLowerTransformer	back to summary
private FSTextTransformer _unicodeToLowerTransformer

_unicodeToTitleTransformer	back to summary
private FSTextTransformer _unicodeToTitleTransformer

_unicodeToUpperTransformer	back to summary
private FSTextTransformer _unicodeToUpperTransformer

canvas	back to summary
protected FSCanvas canvas

characterBreaker	back to summary
private FSTextBreaker characterBreaker

CM__PER__IN	back to summary
private static final float CM__PER__IN

css	back to summary
protected StyleReference css

debug_draw_boxes	back to summary
protected boolean debug_draw_boxes

debug_draw_font_metrics	back to summary
protected boolean debug_draw_font_metrics

debug_draw_inline_boxes	back to summary
protected boolean debug_draw_inline_boxes

debug_draw_line_boxes	back to summary
protected boolean debug_draw_line_boxes

DEFAULT_DOTS_PER_PIXEL	back to summary
private static final int DEFAULT_DOTS_PER_PIXEL Deprecated Belongs in Java2D renderer. Annotations @Deprecated

DEFAULT_DPI	back to summary
private static final float DEFAULT_DPI Deprecated Belongs in Java2D renderer. Annotations @Deprecated

DEFAULT_INTERACTIVE	back to summary
private static final boolean DEFAULT_INTERACTIVE Deprecated Belongs in Java2D renderer. Annotations @Deprecated

defaultPageHeight	back to summary
private Float defaultPageHeight

defaultPageSizeIsInches	back to summary
private boolean defaultPageSizeIsInches

defaultPageWidth	back to summary
private Float defaultPageWidth

dotsPerPixel	back to summary
private int dotsPerPixel Internal program dots per pixel.

dpi	back to summary
private float dpi Used to adjust fonts, ems, points, into screen resolution. Internal program dots per inch.

fontResolver	back to summary
protected FontResolver fontResolver

idMap	back to summary
private Map<String, Box> idMap

interactive	back to summary
private boolean interactive

lineBreaker	back to summary
private FSTextBreaker lineBreaker

media	back to summary
private String media

MM__PER__CM	back to summary
private static final int MM__PER__CM

mmPerDot	back to summary
private float mmPerDot dpi in a more usable way Internal program dots per mm (probably a fraction).

namespaceHandler	back to summary
private NamespaceHandler namespaceHandler

print	back to summary
private boolean print

replacedElementFactory	back to summary
private ReplacedElementFactory replacedElementFactory

replacementText	back to summary
private String replacementText

styleMap	back to summary
private final Map<Element, CalculatedStyle> styleMap

tempCanvas	back to summary
private Rectangle tempCanvas

textRenderer	back to summary
private TextRenderer textRenderer

uac	back to summary
private UserAgentCallback uac

Constructor Detail

SharedContext	back to summary
public SharedContext()

Method Detail

addBoxId	back to summary
public void addBoxId(String id, Box box)

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() Gets the baseURL attribute of the RenderingContext object Returns:String The baseURL value

getBaseURL

back to summary

public String getBaseURL()

Gets the baseURL attribute of the RenderingContext object

Returns:String: The baseURL value

getBoxById	back to summary
public Box getBoxById(String id)

getCanvas	back to summary
public FSCanvas getCanvas()

getCharacterBreaker	back to summary
public FSTextBreaker getCharacterBreaker()

getCss	back to summary
public StyleReference getCss()

getDefaultPageHeight back to summary

public Float getDefaultPageHeight()

Stores a default page height.

Returns:Float: default page height or null.
See Also: isDefaultPageSizeInches()

getDefaultPageWidth back to summary

public Float getDefaultPageWidth()

Stores a default page width.

Returns:Float: default page width or null.
See Also: isDefaultPageSizeInches()

getDotsPerPixel	back to summary
public int getDotsPerPixel() Get the internal dots measurement per CSS pixel.

getDPI

back to summary

public float getDPI()

Gets the dPI attribute of the RenderingContext object

Returns:float: The dPI value

getFixedRectangle	back to summary
public Rectangle getFixedRectangle()

getFont	back to summary
public FSFont getFont(FontSpecification spec)

getFontResolver

back to summary

public FontResolver getFontResolver()

Gets the fontResolver attribute of the Context object

Returns:FontResolver: The fontResolver value

getGlobalCounterContext	back to summary
public RootCounterContext getGlobalCounterContext()

getIdMap	back to summary
public Map<String, Box> getIdMap()

getLineBreaker	back to summary
public FSTextBreaker getLineBreaker()

getMedia	back to summary
public String getMedia() The media for this context

getMmPerDotParent

back to summary

public float getMmPerDotParent()

Gets the dPI attribute in a more useful form of the RenderingContext object

Returns:float: The dPI value

getNamespaceHandler	back to summary
public NamespaceHandler getNamespaceHandler()

getReplacedElementFactory	back to summary
public ReplacedElementFactory getReplacedElementFactory()

getReplacementText

back to summary

public String getReplacementText()

The replacement text to be used if a character cannot be renderered by the current or fallback fonts.

Returns:String: the current replacement text, "#" by default

getStyle	back to summary
public CalculatedStyle getStyle(Element e) Gets the resolved style for an element. All primitive properties will have values. This method uses a cache. If the parent element's style is not cached this method will recursively work up the ancestor list until it styles the document with the initial values of CSS properties.

getTextRenderer	back to summary
public TextRenderer getTextRenderer()

getUac

back to summary

public UserAgentCallback getUac()

Deprecated

Use getUserAgentCallback instead for clearer code.

Gets the uac attribute of the RenderingContext object

Returns:UserAgentCallback

The uac value (user agent).

Annotations

@Deprecated

getUnicodeToLowerTransformer	back to summary
public FSTextTransformer getUnicodeToLowerTransformer()

getUnicodeToTitleTransformer	back to summary
public FSTextTransformer getUnicodeToTitleTransformer()

getUnicodeToUpperTransformer	back to summary
public FSTextTransformer getUnicodeToUpperTransformer()

getUserAgentCallback	back to summary
public UserAgentCallback getUserAgentCallback()

getXHeight	back to summary
public float getXHeight(FontContext fontContext, FontSpecification fs)

isDefaultPageSizeInches

back to summary

public boolean isDefaultPageSizeInches()

If not, consider it as mm.

Returns:boolean: true if the page size is in inches, false if it is in mm.

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()

newLayoutContextInstance	back to summary
public LayoutContext newLayoutContextInstance()

newRenderingContextInstance	back to summary
public RenderingContext newRenderingContextInstance()

registerWithThread	back to summary
public void registerWithThread() This registers the shared context with a thread local so it can be used anywhere. It should be matched with a call to `removeFromThread()` when the run is complete.

removeBoxId	back to summary
public void removeBoxId(String id)

removeFromThread	back to summary
public void removeFromThread() This removes the shared context from a thread local to avoid memory leaks.

setBaseURL

back to summary

public void setBaseURL(String url)

Sets the baseURL attribute of the RenderingContext object

Parameters

url:String: The new baseURL value

setCanvas	back to summary
public void setCanvas(FSCanvas canvas)

setCharacterBreaker	back to summary
public void setCharacterBreaker(FSTextBreaker breaker)

setCss	back to summary
public void setCss(StyleReference css)

setDebug_draw_boxes	back to summary
public void setDebug_draw_boxes(boolean debug_draw_boxes)

setDebug_draw_font_metrics	back to summary
public void setDebug_draw_font_metrics(boolean debug_draw_font_metrics)

setDebug_draw_inline_boxes	back to summary
public void setDebug_draw_inline_boxes(boolean debug_draw_inline_boxes)

setDebug_draw_line_boxes	back to summary
public void setDebug_draw_line_boxes(boolean debug_draw_line_boxes)

setDefaultPageSize	back to summary
public void setDefaultPageSize(Float pageWidth, Float pageHeight, boolean isInches) Set the default page dimensions. These may be overridden in CSS. If not set in CSS and null here, A4 will be used.

setDotsPerPixel	back to summary
public void setDotsPerPixel(int dotsPerPixel) Set the internal dots measurement per CSS pixel.

setDPI back to summary

public void setDPI(float dpi)

Sets the effective DPI (Dots Per Inch) of the screen. You should normally never need to override the dpi, as it is already set to the system default by Toolkit.getDefaultToolkit().getScreenResolution() You can override the value if you want to scale EVERYTHING.

Parameters

dpi:float: The new dPI value

setFontMapping

back to summary

public void setFontMapping(String name, Font font)

Deprecated

Definitely shouldn't use this method as it only applies for Java2D font resolver. Instead call getFontResolver, cast and use font adding methods on that.

Adds or overrides a font mapping, meaning you can associate a particular font with a particular string. For example, the following would load a font out of the cool.ttf file and associate it with the name CoolFont :

  Font font = Font.createFont(Font.TRUETYPE_FONT,
  new FileInputStream("cool.ttf");
  setFontMapping("CoolFont", font);

You could then put the following css in your page

  p { font-family: CoolFont Arial sans-serif; }

You can also override existing font mappings, like replacing Arial with Helvetica.

Parameters

name:String: The new font name
font:Font: The actual Font to map

Annotations

@Deprecated

setFontResolver	back to summary
public void setFontResolver(FontResolver resolver)

setInteractive	back to summary
public void setInteractive(boolean interactive)

setLineBreaker	back to summary
public void setLineBreaker(FSTextBreaker breaker)

setMedia

back to summary

public void setMedia(String media)

Set the current media type. This is usually something like screen or print . See the media section of the CSS 2.1 spec for more information on media types.

Parameters

media:String: The new media value

setNamespaceHandler	back to summary
public void setNamespaceHandler(NamespaceHandler nh)

setPrint	back to summary
public void setPrint(boolean print)

setReplacedElementFactory	back to summary
public void setReplacedElementFactory(ReplacedElementFactory ref)

setReplacementText	back to summary
public void setReplacementText(String replacement)

setTempCanvas	back to summary
public void setTempCanvas(Rectangle rect)

setTextRenderer

back to summary

public void setTextRenderer(TextRenderer textRenderer)

Sets the textRenderer attribute of the RenderingContext object

Parameters

textRenderer:TextRenderer: The new textRenderer value

setUnicodeToLowerTransformer	back to summary
public void setUnicodeToLowerTransformer(FSTextTransformer tr)

setUnicodeToTitleTransformer	back to summary
public void setUnicodeToTitleTransformer(FSTextTransformer tr)

setUnicodeToUpperTransformer	back to summary
public void setUnicodeToUpperTransformer(FSTextTransformer tr)

setUserAgentCallback	back to summary
public void setUserAgentCallback(UserAgentCallback userAgentCallback)

public Class SharedContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail