Top Description Fields Constructors Methods
com.vladsch.flexmark.ext.wikilink

public Class WikiLinkExtension

extends Object
implements ParserExtension, HtmlRendererExtension, FormatterExtension
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.formatter.Formatter.FormatterExtension, com.vladsch.flexmark.util.misc.Extension, com.vladsch.flexmark.html.HtmlRenderer.HtmlRendererExtension, com.vladsch.flexmark.parser.Parser.ParserExtension
Imports
com.vladsch.flexmark.ext.wikilink.internal.*, com.vladsch.flexmark.formatter.Formatter, com.vladsch.flexmark.html.HtmlRenderer, com.vladsch.flexmark.html.renderer.LinkType, com.vladsch.flexmark.parser.Parser, com.vladsch.flexmark.util.data.DataKey, .MutableDataHolder, org.jetbrains.annotations.NotNull
Extension for wikilinks

Create it with create() and then configure it on the builders

The parsed emoji shortcuts text regions are turned into WikiLink nodes.

Field Summary

Modifier and TypeField and Description
public static final DataKey<Boolean>
ALLOW_ANCHOR_ESCAPE

public static final DataKey<Boolean>
ALLOW_ANCHORS

public static final DataKey<Boolean>
ALLOW_INLINES

public static final DataKey<Boolean>
ALLOW_PIPE_ESCAPE

public static final DataKey<Boolean>
DISABLE_RENDERING

public static final DataKey<String>
IMAGE_FILE_EXTENSION

public static final DataKey<Boolean>
IMAGE_LINKS

public static final DataKey<String>
IMAGE_PREFIX

public static final DataKey<String>
IMAGE_PREFIX_ABSOLUTE

Image prefix to use for absolute wiki image sources starting with the '/' character.

public static final LinkType
WIKI_LINK

Constructor Summary

AccessConstructor and Description
private
WikiLinkExtension()

Method Summary

Modifier and TypeMethod and Description
public static WikiLinkExtension
create()

public void
extend(Formatter.Builder formatterBuilder)

Implements com.vladsch.flexmark.formatter.Formatter.FormatterExtension.extend.

public void
extend(Parser.Builder
parser builder with which to register extensions
parserBuilder)

Implements com.vladsch.flexmark.parser.Parser.ParserExtension.extend.

This method is called on all extensions so that they can register their custom processors

public void
extend(HtmlRenderer.Builder htmlRendererBuilder, @NotNull String rendererType)

public void
parserOptions(MutableDataHolder
option set that will be used for the builder
options)

Implements com.vladsch.flexmark.parser.Parser.ParserExtension.parserOptions.

This method is called first on all extensions so that they can adjust the options that must be common to all extensions.

public void
rendererOptions(@NotNull MutableDataHolder
option set that will be used for the builder
options)

Implements com.vladsch.flexmark.formatter.Formatter.FormatterExtension.rendererOptions.

This method is called first on all extensions so that they can adjust the options.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ALLOW_ANCHOR_ESCAPEback to summary
public static final DataKey<Boolean> ALLOW_ANCHOR_ESCAPE
ALLOW_ANCHORSback to summary
public static final DataKey<Boolean> ALLOW_ANCHORS
ALLOW_INLINESback to summary
public static final DataKey<Boolean> ALLOW_INLINES
ALLOW_PIPE_ESCAPEback to summary
public static final DataKey<Boolean> ALLOW_PIPE_ESCAPE
DISABLE_RENDERINGback to summary
public static final DataKey<Boolean> DISABLE_RENDERING
IMAGE_FILE_EXTENSIONback to summary
public static final DataKey<String> IMAGE_FILE_EXTENSION
IMAGE_PREFIXback to summary
public static final DataKey<String> IMAGE_PREFIX
IMAGE_PREFIX_ABSOLUTEback to summary
public static final DataKey<String> IMAGE_PREFIX_ABSOLUTE

Image prefix to use for absolute wiki image sources starting with the '/' character.

Will get its value from option IMAGE_PREFIX until its own value is set.

Constructor Detail

WikiLinkExtensionback to summary
private WikiLinkExtension()

Method Detail

createback to summary
public static WikiLinkExtension create()
extendback to summary
public void extend(Formatter.Builder formatterBuilder)

Implements com.vladsch.flexmark.formatter.Formatter.FormatterExtension.extend.

Annotations
@Override
extendback to summary
public void extend(Parser.Builder parserBuilder)

Implements com.vladsch.flexmark.parser.Parser.ParserExtension.extend.

Doc from com.vladsch.flexmark.parser.Parser.ParserExtension.extend.

This method is called on all extensions so that they can register their custom processors

Parameters
parserBuilder:Parser.Builder

parser builder with which to register extensions

Annotations
@Override
extendback to summary
public void extend(HtmlRenderer.Builder htmlRendererBuilder, @NotNull String rendererType)
Annotations
@Override
parserOptionsback to summary
public void parserOptions(MutableDataHolder options)

Implements com.vladsch.flexmark.parser.Parser.ParserExtension.parserOptions.

Doc from com.vladsch.flexmark.parser.Parser.ParserExtension.parserOptions.

This method is called first on all extensions so that they can adjust the options that must be common to all extensions.

Parameters
options:MutableDataHolder

option set that will be used for the builder

Annotations
@Override
rendererOptionsback to summary
public void rendererOptions(@NotNull MutableDataHolder options)

Implements com.vladsch.flexmark.formatter.Formatter.FormatterExtension.rendererOptions.

Doc from com.vladsch.flexmark.formatter.Formatter.FormatterExtension.rendererOptions.

This method is called first on all extensions so that they can adjust the options.

Parameters
options:@NotNull MutableDataHolder

option set that will be used for the builder

Annotations
@Override