html-to-node 0.1.0 · org.jabref.htmltonode.HtmlView · APIdia, the JavaDoc alternative

A small pane that renders an HTML string as JavaFX nodes — the drop-in content for the ScrollPane that JabRef's PreviewViewer already is (instead of a WebView).

Not a live browser: re-renders whenever htmlProperty() or optionsProperty() changes. Must be used on the JavaFX application thread, like any other node.

Field Summary

Modifier and Type	Field and Description
private final StringProperty	html
private final ObjectProperty<HtmlRenderOptions>	options

Constructor Summary

Access	Constructor and Description
public	HtmlView() Creates an empty view with `HtmlRenderOptions#defaults()`.
public	HtmlView(@Nullable String the initial HTML content; `null` is treated as empty html) Creates a view showing `html` with `HtmlRenderOptions#defaults()`.

Method Summary

Modifier and Type	Method and Description
public final void	clearSelection() Clears the mouse text selection.
public final String	getHtml() Returns: the current HTML content; never `null`
public final HtmlRenderOptions	getOptions() Returns: the current rendering options; never `null`
public final Optional<String>	getSelectedText() Returns: the text currently selected with the mouse, if any
public final StringProperty	Returns: the html property htmlProperty() The HTML content of this view.
public final boolean	isPressOnSelection() Returns: whether the current mouse press started on an existing selection — drag-and-drop consumers should only drag the content in that case, otherwise dragging extends the text selection
public final ObjectProperty<HtmlRenderOptions>	Returns: the options property optionsProperty() The rendering options of this view.
private void	rerender()
private Optional<TextSelection>	selection()
public final void	setHtml(@Nullable String the HTML content to render; `null` is treated as empty newHtml)
public final void	setOptions(@Nullable HtmlRenderOptions the rendering options; `null` restores `HtmlRenderOptions#defaults()` newOptions)
public final String	Returns: the plain text; see `HtmlToNode#toPlainText(String)` toPlainText() Extracts readable plain text from the current content, e.g. for "copy as text".

Field Detail

html	back to summary
private final StringProperty html

options	back to summary
private final ObjectProperty<HtmlRenderOptions> options

Constructor Detail

HtmlView	back to summary
public HtmlView() Creates an empty view with `HtmlRenderOptions#defaults()`.

HtmlView back to summary

HtmlView	back to summary
public HtmlView(@Nullable String html) Creates a view showing `html` with `HtmlRenderOptions#defaults()`. Parameters html:@Nullable String the initial HTML content; `null` is treated as empty

public HtmlView(@Nullable String html)

Creates a view showing html with HtmlRenderOptions#defaults().

Parameters

html:@Nullable String: the initial HTML content; null is treated as empty

Method Detail

clearSelection	back to summary
public final void clearSelection() Clears the mouse text selection.

getHtml	back to summary
public final String getHtml() Returns:String the current HTML content; never `null`

getOptions	back to summary
public final HtmlRenderOptions getOptions() Returns:HtmlRenderOptions the current rendering options; never `null`

getSelectedText	back to summary
public final Optional<String> getSelectedText() Returns:Optional<String> the text currently selected with the mouse, if any

htmlProperty back to summary

htmlProperty	back to summary
public final StringProperty htmlProperty() The HTML content of this view. Setting a new value re-renders. Never `null`. Returns:StringProperty the html property

public final StringProperty htmlProperty()

The HTML content of this view. Setting a new value re-renders. Never null.

Returns:StringProperty: the html property

isPressOnSelection	back to summary
public final boolean isPressOnSelection() Returns:boolean whether the current mouse press started on an existing selection — drag-and-drop consumers should only drag the content in that case, otherwise dragging extends the text selection

optionsProperty back to summary

optionsProperty	back to summary
public final ObjectProperty<HtmlRenderOptions> optionsProperty() The rendering options of this view. Setting a new value re-renders. Never `null`. Returns:ObjectProperty<HtmlRenderOptions> the options property

public final ObjectProperty<HtmlRenderOptions> optionsProperty()

The rendering options of this view. Setting a new value re-renders. Never null.

Returns:ObjectProperty<HtmlRenderOptions>: the options property

rerender	back to summary
private void rerender()

selection	back to summary
private Optional<TextSelection> selection()

setHtml	back to summary
public final void setHtml(@Nullable String newHtml) Parameters newHtml:@Nullable String the HTML content to render; `null` is treated as empty

setOptions	back to summary
public final void setOptions(@Nullable HtmlRenderOptions newOptions) Parameters newOptions:@Nullable HtmlRenderOptions the rendering options; `null` restores `HtmlRenderOptions#defaults()`

toPlainText back to summary

toPlainText	back to summary
public final String toPlainText() Extracts readable plain text from the current content, e.g. for "copy as text". Returns:String the plain text; see `HtmlToNode#toPlainText(String)`

public final String toPlainText()

Extracts readable plain text from the current content, e.g. for "copy as text".