html-to-node 0.1.0 · org.jabref.htmltonode.rich.RichTextRenderer

Renders the block model into a RichTextArea (JavaFX incubator control) — the selection-, caret- and accessibility-capable alternative to FxRenderer.

Inline content maps to styled segments (StyleAttributeMap); <mark>/background runs map to native highlights; links carry the custom HREF attribute and are resolved on click via RichTextArea#getTextPosition. Tables and horizontal rules are embedded as node paragraphs rendered by FxRenderer; images are embedded as inline nodes. Known interim gaps (tracked upstream, see the project's issue #2): sub-/superscript lose their baseline shift and numeric font weights collapse to bold/normal.

Field Summary

Modifier and Type	Field and Description
private final String	baseFamily
private final double	baseSize
public static final StyleAttribute<String>	HREF Character attribute carrying a link target; resolved on mouse click.
private double	indent left indent (in px) applied to paragraphs, e.g. inside `<blockquote>`
private static final Color	LINK_COLOR Fallback link color; matches FxRenderer's un-themed link fill.
private final SimpleViewOnlyStyledModel	model
private final HtmlRenderOptions	options
private boolean	paragraphOccupied whether the model's last paragraph is occupied (text, node, or a preserved blank line)
private int	paragraphOffset characters already added to the paragraph currently being built
private @Nullable String	pendingMarker marker text (e.g. `•` , `3.`

Constructor Summary

Access	Constructor and Description
private	RichTextRenderer(HtmlRenderOptions options)

Method Summary

Modifier and Type	Method and Description
private void	appendBlocks(List<Block> blocks)
private void	appendRun(String text, InlineStyle style)
private StyleAttributeMap	attributes(InlineStyle style, double sizeFactor)
public static StyledTextModel	Returns: a read-only model for `RichTextArea#setModel` buildModel(List<Block> the blocks to render, typically from `HtmlToNode.parse(...)` blocks, HtmlRenderOptions rendering options options) Builds the styled document model.
public static void	configure(RichTextArea area, HtmlRenderOptions options) Applies the standard preview configuration (read-only, wrapping, link clicks) to `area`.
private void	embed(List<Block> blocks) Embeds blocks as a self-contained node paragraph rendered by `FxRenderer` (tables, rules).
public static @Nullable String	hrefAt(StyledTextModel model, TextPos position) Returns the link target at `position`, or `null` if there is none.
private void	paragraph(List<Inline> inlines, double scale, int minWeight, double spaceAbove)
public static RichTextArea	Returns: the configured control render(List<Block> the blocks to render blocks, HtmlRenderOptions rendering options options) Renders the blocks into a ready-to-use, read-only `RichTextArea` with wrapping and link-click handling.
private void	separateParagraph()
private void	startParagraph(double spaceAbove) Ends the previous paragraph (if occupied) and applies attributes/markers to the new one.

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

Field Detail

baseFamily	back to summary
private final String baseFamily

baseSize	back to summary
private final double baseSize

HREF	back to summary
public static final StyleAttribute<String> HREF Character attribute carrying a link target; resolved on mouse click.

indent	back to summary
private double indent left indent (in px) applied to paragraphs, e.g. inside `<blockquote>`

LINK_COLOR	back to summary
private static final Color LINK_COLOR Fallback link color; matches FxRenderer's un-themed link fill.

model	back to summary
private final SimpleViewOnlyStyledModel model

options	back to summary
private final HtmlRenderOptions options

paragraphOccupied	back to summary
private boolean paragraphOccupied whether the model's last paragraph is occupied (text, node, or a preserved blank line)

paragraphOffset	back to summary
private int paragraphOffset characters already added to the paragraph currently being built

pendingMarker	back to summary
private @Nullable String pendingMarker marker text (e.g. `•` , `3.` ) to prepend to the next paragraph

Constructor Detail

RichTextRenderer	back to summary
private RichTextRenderer(HtmlRenderOptions options)

Method Detail

appendBlocks	back to summary
private void appendBlocks(List<Block> blocks)

appendRun	back to summary
private void appendRun(String text, InlineStyle style)

attributes	back to summary
private StyleAttributeMap attributes(InlineStyle style, double sizeFactor)

buildModel back to summary

buildModel	back to summary
public static StyledTextModel buildModel(List<Block> blocks, HtmlRenderOptions options) Builds the styled document model. Does not require the JavaFX toolkit. Parameters blocks:List<Block> the blocks to render, typically from `HtmlToNode.parse(...)` options:HtmlRenderOptions rendering options Returns:StyledTextModel a read-only model for `RichTextArea#setModel`

public static StyledTextModel buildModel(List<Block> blocks, HtmlRenderOptions options)

Builds the styled document model. Does not require the JavaFX toolkit.

Parameters

blocks:List<Block>: the blocks to render, typically from HtmlToNode.parse(...)
options:HtmlRenderOptions: rendering options

Returns:StyledTextModel

a read-only model for RichTextArea#setModel

configure	back to summary
public static void configure(RichTextArea area, HtmlRenderOptions options) Applies the standard preview configuration (read-only, wrapping, link clicks) to `area`.

embed	back to summary
private void embed(List<Block> blocks) Embeds blocks as a self-contained node paragraph rendered by `FxRenderer` (tables, rules).

hrefAt back to summary

hrefAt	back to summary
public static @Nullable String hrefAt(StyledTextModel model, TextPos position) Returns the link target at `position`, or `null` if there is none. Node segments (embedded images, tables) carry no character attributes, so the model returns a null attribute map there — only text runs can hold an `HREF`. Clicking an image therefore lands on a null map, which this method tolerates.

public static @Nullable String hrefAt(StyledTextModel model, TextPos position)

Returns the link target at position, or null if there is none.

Node segments (embedded images, tables) carry no character attributes, so the model returns a null attribute map there — only text runs can hold an HREF. Clicking an image therefore lands on a null map, which this method tolerates.

paragraph	back to summary
private void paragraph(List<Inline> inlines, double scale, int minWeight, double spaceAbove)

render back to summary

render	back to summary
public static RichTextArea render(List<Block> blocks, HtmlRenderOptions options) Renders the blocks into a ready-to-use, read-only `RichTextArea` with wrapping and link-click handling. Must be used on the JavaFX application thread. Parameters blocks:List<Block> the blocks to render options:HtmlRenderOptions rendering options Returns:RichTextArea the configured control

public static RichTextArea render(List<Block> blocks, HtmlRenderOptions options)

Renders the blocks into a ready-to-use, read-only RichTextArea with wrapping and link-click handling. Must be used on the JavaFX application thread.