org.hkijena.jipipe.ui.components.markdown

Class MarkdownDocument

java.lang.Object

org.hkijena.jipipe.ui.components.markdown.MarkdownDocument

public class MarkdownDocument
extends Object

Contains Markdown data

Constructor Summary

Constructors

Constructor and Description
MarkdownDocument()
MarkdownDocument(String markdown)

Method Summary

Modifier and Type	Method and Description
static MarkdownDocument	fromFile(Path fileName) Loads a document from file
static MarkdownDocument	fromPluginResource(String internalPath, Map<String,Class<?>> additionalResourceProtocols) Loads a document from the JIPipe plugin resources
static MarkdownDocument	fromResourceURL(URL resourcePath, boolean enableResourceProtocol, Map<String,Class<?>> additionalResourceProtocols) Loads a document from a resource URL
String	getMarkdown()
String	getRenderedHTML()
HTMLText	getRenderedHTMLText()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MarkdownDocument

public MarkdownDocument()

MarkdownDocument

public MarkdownDocument(String markdown)

Parameters:

markdown - markdown text

Method Detail

fromFile

public static MarkdownDocument fromFile(Path fileName)

Loads a document from file

Parameters:

fileName - filename

Returns:

the document

fromPluginResource

public static MarkdownDocument fromPluginResource(String internalPath,
                                                  Map<String,Class<?>> additionalResourceProtocols)

Loads a document from the JIPipe plugin resources

Parameters:

internalPath - resource path. Relative to JIPipe resources

additionalResourceProtocols - Additional protocols. The key is the name of the protocol, while the value sets the resource loader class

Returns:

the document

fromResourceURL

public static MarkdownDocument fromResourceURL(URL resourcePath,
                                               boolean enableResourceProtocol,
                                               Map<String,Class<?>> additionalResourceProtocols)

Loads a document from a resource URL

Parameters:

resourcePath - resource path

enableResourceProtocol - Allows to target core JIPipe resources with resource://

additionalResourceProtocols - Additional protocols. The key is the name of the protocol, while the value sets the resource loader class

Returns:

the document

getRenderedHTML

public String getRenderedHTML()

getRenderedHTMLText

public HTMLText getRenderedHTMLText()

getMarkdown

public String getMarkdown()