Package org.vaadin.firitin.components

Class RichText

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.HtmlComponent

com.vaadin.flow.component.HtmlContainer

com.vaadin.flow.component.html.Div

org.vaadin.firitin.components.RichText

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.ClickNotifier<com.vaadin.flow.component.html.Div>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasOrderedComponents, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasText, Serializable

public class RichText
extends com.vaadin.flow.component.html.Div

XSS safe rich text label with either Markdown syntax or raw html (sanitized with Jsoup).

By default jsoups Safelist.relaxed is used for sanitizing. This can be overridden by returning custom safelist with getSafelist method.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasText

com.vaadin.flow.component.HasText.WhiteSpace

Constructor Summary

Constructors

Constructor	Description
RichText()
RichText(String content)

Method Summary

Modifier and Type	Method	Description
protected com.vladsch.flexmark.parser.Parser	getMdParser()
protected com.vladsch.flexmark.html.HtmlRenderer	getMdRenderer()
org.jsoup.safety.Safelist	getSafelist()
String	getText()	Deprecated. might return null if text not set with setRichTextAndSaveReference method.
org.jsoup.safety.Safelist	getWhitelist()	Deprecated. use getSafelist instead
RichText	setRichText(String text)
RichText	setRichTextAndSaveReference(String text)
RichText	setSafelist(org.jsoup.safety.Safelist whitelist)	Deprecated. Whitelist is not serializable.
RichText	withContent(String content)
RichText	withMarkDown(InputStream markdown)
RichText	withMarkDown(String markdown)
RichText	withMarkDownResource(String resourceName)
RichText	withNewLines(String text)	Only replaces all new line characters with <br />, but no Markdown processing.
RichText	withSafeHtml(InputStream markdown)
RichText	withSafeHtml(String html)
RichText	withSafeHtmlResource(String resourceName)

Methods inherited from class com.vaadin.flow.component.HtmlComponent

getTitle, setTitle

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.ClickNotifier

addClickListener, addClickShortcut, addDoubleClickListener, addSingleClickListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.HasComponents

add, add, add, addComponentAsFirst, addComponentAtIndex, remove, remove, removeAll

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.component.HasOrderedComponents

getChildren, getComponentAt, getComponentCount, indexOf, replace

Methods inherited from interface com.vaadin.flow.component.HasSize

getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Methods inherited from interface com.vaadin.flow.component.HasText

getWhiteSpace, setText, setWhiteSpace

Constructor Details

RichText

public RichText()

RichText

public RichText(String content)

Method Details

getMdParser

protected com.vladsch.flexmark.parser.Parser getMdParser()

getMdRenderer

protected com.vladsch.flexmark.html.HtmlRenderer getMdRenderer()

withMarkDown

public RichText withMarkDown(String markdown)

withMarkDown

public RichText withMarkDown(InputStream markdown)

withSafeHtml

public RichText withSafeHtml(String html)

withSafeHtml

public RichText withSafeHtml(InputStream markdown)

withNewLines

public RichText withNewLines(String text)

Only replaces all new line characters with <br />, but no Markdown processing.

Parameters:

text - the text value to be displayed

Returns:

the object itself for further configuration

getWhitelist

@Deprecated
public org.jsoup.safety.Safelist getWhitelist()

Deprecated.

use getSafelist instead

Returns:

the safelist

getSafelist

public org.jsoup.safety.Safelist getSafelist()

setSafelist

@Deprecated
public RichText setSafelist(org.jsoup.safety.Safelist whitelist)

Deprecated.

Whitelist is not serializable. Override getWhitelist instead if you need to support serialiazation

Parameters:

whitelist - the whitelist used for sanitizing the rich text content

Returns:

the object itself for further configuration

getText

@Deprecated
public String getText()

Deprecated.

might return null if text not set with setRichTextAndSaveReference method.

Return the richt text set using setRichTextAndSaveReference method. Normally reference to the content is not saved to save server memory.

Returns:

the rich text set to this content, if available

setRichText

public RichText setRichText(String text)

setRichTextAndSaveReference

public RichText setRichTextAndSaveReference(String text)

withMarkDownResource

public RichText withMarkDownResource(String resourceName)

withSafeHtmlResource

public RichText withSafeHtmlResource(String resourceName)

withContent

public RichText withContent(String content)