io.wcm.handler.richtext

Interface RichTextBuilder

@ProviderType
public interface RichTextBuilder

Define rich text handling request using builder pattern.

Method Summary

Modifier and Type	Method and Description
RichText	build() Build formatted markup and return metadata object containing results.
Collection<org.jdom2.Content>	buildContent() Build formatted markup as DOM elements.
String	buildMarkup() Build formatted markup string.
RichTextBuilder	mediaArgs(io.wcm.handler.media.MediaArgs mediaArgs) Set media arguments to be applied when resolving inline images.
RichTextBuilder	textMode(TextMode textMode) Set in which text mode the raw text should be interpreded.
RichTextBuilder	urlMode(io.wcm.handler.url.UrlMode urlMode) Set URL mode to be applied for building URLs for inline links and inline images.

Method Detail

textMode

RichTextBuilder textMode(TextMode textMode)

Set in which text mode the raw text should be interpreded.

Parameters:

textMode - Text mode

Returns:

Rich text builder

mediaArgs

RichTextBuilder mediaArgs(io.wcm.handler.media.MediaArgs mediaArgs)

Set media arguments to be applied when resolving inline images.

Parameters:

mediaArgs - Media arguments

Returns:

Rich text builder

urlMode

RichTextBuilder urlMode(io.wcm.handler.url.UrlMode urlMode)

Set URL mode to be applied for building URLs for inline links and inline images.

Parameters:

urlMode - URL mode

Returns:

Rich text builder

build

RichText build()

Build formatted markup and return metadata object containing results.

Returns:

Rich text metadata. Never null, if the resolving failed the isValid() method returns false.

buildMarkup

String buildMarkup()

Build formatted markup string.

Returns:

Formatted markup string or null if invalid or empty.

buildContent

Collection<org.jdom2.Content> buildContent()

Build formatted markup as DOM elements.

Returns:

DOM elements or empty collection if invalid or empty.