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 java.lang.Object implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension, Formatter.FormatterExtension
-
-
Field Summary
Fields Modifier and Type Field Description static DataKey<java.lang.Boolean>
ALLOW_ANCHOR_ESCAPE
static DataKey<java.lang.Boolean>
ALLOW_ANCHORS
static DataKey<java.lang.Boolean>
ALLOW_INLINES
static DataKey<java.lang.Boolean>
ALLOW_PIPE_ESCAPE
static DataKey<java.lang.Boolean>
DISABLE_RENDERING
static DataKey<java.lang.String>
IMAGE_FILE_EXTENSION
static DataKey<java.lang.Boolean>
IMAGE_LINKS
static DataKey<java.lang.String>
IMAGE_PREFIX
static DataKey<java.lang.String>
IMAGE_PREFIX_ABSOLUTE
Image prefix to use for absolute wiki image sources starting with the'/'
character.static DataKey<java.lang.String>
LINK_ESCAPE_CHARS
Characters to escape in wiki links.static DataKey<java.lang.String>
LINK_FILE_EXTENSION
static DataKey<java.lang.Boolean>
LINK_FIRST_SYNTAX
static DataKey<java.lang.String>
LINK_PREFIX
static DataKey<java.lang.String>
LINK_PREFIX_ABSOLUTE
Link prefix to use for absolute wiki links starting with the'/'
character.static DataKey<java.lang.String>
LINK_REPLACE_CHARS
Characters to replaceLINK_ESCAPE_CHARS
with.static LinkType
WIKI_LINK
-
Fields inherited from interface com.vladsch.flexmark.util.misc.Extension
EMPTY_LIST
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static WikiLinkExtension
create()
void
extend(Formatter.Builder formatterBuilder)
void
extend(HtmlRenderer.Builder htmlRendererBuilder, java.lang.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(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 Detail
-
ALLOW_INLINES
public static final DataKey<java.lang.Boolean> ALLOW_INLINES
-
ALLOW_ANCHORS
public static final DataKey<java.lang.Boolean> ALLOW_ANCHORS
-
ALLOW_ANCHOR_ESCAPE
public static final DataKey<java.lang.Boolean> ALLOW_ANCHOR_ESCAPE
-
ALLOW_PIPE_ESCAPE
public static final DataKey<java.lang.Boolean> ALLOW_PIPE_ESCAPE
-
DISABLE_RENDERING
public static final DataKey<java.lang.Boolean> DISABLE_RENDERING
-
LINK_FIRST_SYNTAX
public static final DataKey<java.lang.Boolean> LINK_FIRST_SYNTAX
-
LINK_PREFIX
public static final DataKey<java.lang.String> LINK_PREFIX
-
LINK_PREFIX_ABSOLUTE
public static final DataKey<java.lang.String> 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
public static final DataKey<java.lang.String> IMAGE_PREFIX
-
IMAGE_PREFIX_ABSOLUTE
public static final DataKey<java.lang.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.
-
IMAGE_LINKS
public static final DataKey<java.lang.Boolean> IMAGE_LINKS
-
LINK_FILE_EXTENSION
public static final DataKey<java.lang.String> LINK_FILE_EXTENSION
-
IMAGE_FILE_EXTENSION
public static final DataKey<java.lang.String> IMAGE_FILE_EXTENSION
-
LINK_ESCAPE_CHARS
public static final DataKey<java.lang.String> 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
public static final DataKey<java.lang.String> LINK_REPLACE_CHARS
Characters to replaceLINK_ESCAPE_CHARS
with.- See Also:
LINK_ESCAPE_CHARS
-
WIKI_LINK
public static final LinkType WIKI_LINK
-
-
Method Detail
-
create
public static WikiLinkExtension create()
-
rendererOptions
public void rendererOptions(@NotNull MutableDataHolder options)
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
public void parserOptions(MutableDataHolder options)
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
public void extend(Formatter.Builder formatterBuilder)
- Specified by:
extend
in interfaceFormatter.FormatterExtension
-
extend
public void extend(Parser.Builder parserBuilder)
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:
Parser.Builder.customBlockParserFactory(CustomBlockParserFactory)
,Parser.Builder.customInlineParserExtensionFactory(InlineParserExtensionFactory)
,Parser.Builder.customInlineParserFactory(InlineParserFactory)
,Parser.Builder.customDelimiterProcessor(DelimiterProcessor)
,Parser.Builder.postProcessorFactory(PostProcessorFactory)
,Parser.Builder.paragraphPreProcessorFactory(ParagraphPreProcessorFactory)
,Parser.Builder.blockPreProcessorFactory(BlockPreProcessorFactory)
,Parser.Builder.linkRefProcessorFactory(LinkRefProcessorFactory)
,Parser.Builder.specialLeadInHandler(SpecialLeadInHandler)
-
extend
public void extend(@NotNull HtmlRenderer.Builder htmlRendererBuilder, @NotNull java.lang.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:
HtmlRenderer.Builder.attributeProviderFactory(AttributeProviderFactory)
,HtmlRenderer.Builder.nodeRendererFactory(NodeRendererFactory)
,HtmlRenderer.Builder.linkResolverFactory(LinkResolverFactory)
,HtmlRenderer.Builder.htmlIdGeneratorFactory(HeaderIdGeneratorFactory)
-
-