Class WikiLinkExtension
java.lang.Object
com.vladsch.flexmark.ext.wikilink.WikiLinkExtension
- All Implemented Interfaces:
Formatter.FormatterExtension
,HtmlRenderer.HtmlRendererExtension
,Parser.ParserExtension
,Extension
public class WikiLinkExtension
extends Object
implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension, Formatter.FormatterExtension
-
Field Summary
FieldsModifier and TypeFieldDescriptionImage prefix to use for absolute wiki image sources starting with the'/'
character.Characters to escape in wiki links.Link prefix to use for absolute wiki links starting with the'/'
character.Characters to replaceLINK_ESCAPE_CHARS
with.static final LinkType
Fields inherited from interface com.vladsch.flexmark.util.misc.Extension
EMPTY_LIST
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic WikiLinkExtension
create()
void
extend
(Formatter.Builder formatterBuilder) void
extend
(HtmlRenderer.Builder htmlRendererBuilder, @NotNull String rendererType) Called to give each extension to register extension points that it containsvoid
extend
(Parser.Builder parserBuilder) This method is called on all extensions so that they can register their custom processorsvoid
parserOptions
(MutableDataHolder options) This method is called first on all extensions so that they can adjust the options that must be common to all extensions.void
rendererOptions
(@NotNull MutableDataHolder options) This method is called first on all extensions so that they can adjust the options that must be common to all extensions.
-
Field Details
-
ALLOW_INLINES
-
ALLOW_ANCHORS
-
ALLOW_ANCHOR_ESCAPE
-
ALLOW_PIPE_ESCAPE
-
DISABLE_RENDERING
-
LINK_FIRST_SYNTAX
-
LINK_PREFIX
-
LINK_PREFIX_ABSOLUTE
Link prefix to use for absolute wiki links starting with the'/'
character.Will get its value from option
LINK_PREFIX
until its own value is set. -
IMAGE_PREFIX
-
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. -
IMAGE_LINKS
-
LINK_FILE_EXTENSION
-
IMAGE_FILE_EXTENSION
-
LINK_ESCAPE_CHARS
Characters to escape in wiki links.Each character in the configuration string is replaced with a character at the corresponding index in the string given by the configuration option
LINK_REPLACE_CHARS
. -
LINK_REPLACE_CHARS
Characters to replaceLINK_ESCAPE_CHARS
with.- See Also:
-
WIKI_LINK
-
-
Constructor Details
-
WikiLinkExtension
private WikiLinkExtension()
-
-
Method Details
-
create
-
rendererOptions
Description copied from interface:HtmlRenderer.HtmlRendererExtension
This method is called first on all extensions so that they can adjust the options that must be common to all extensions.- Specified by:
rendererOptions
in interfaceFormatter.FormatterExtension
- Specified by:
rendererOptions
in interfaceHtmlRenderer.HtmlRendererExtension
- Parameters:
options
- option set that will be used for the builder
-
parserOptions
Description copied from interface:Parser.ParserExtension
This method is called first on all extensions so that they can adjust the options that must be common to all extensions.- Specified by:
parserOptions
in interfaceParser.ParserExtension
- Parameters:
options
- option set that will be used for the builder
-
extend
- Specified by:
extend
in interfaceFormatter.FormatterExtension
-
extend
Description copied from interface:Parser.ParserExtension
This method is called on all extensions so that they can register their custom processors- Specified by:
extend
in interfaceParser.ParserExtension
- Parameters:
parserBuilder
- parser builder with which to register extensions- See Also:
-
extend
public void extend(@NotNull HtmlRenderer.Builder htmlRendererBuilder, @NotNull @NotNull String rendererType) Description copied from interface:HtmlRenderer.HtmlRendererExtension
Called to give each extension to register extension points that it contains- Specified by:
extend
in interfaceHtmlRenderer.HtmlRendererExtension
- Parameters:
htmlRendererBuilder
- builder to call back for extension point registrationrendererType
- type of rendering being performed. For now "HTML", "JIRA" or "YOUTRACK"- See Also:
-