Package com.vladsch.flexmark.ext.emoji

Class EmojiExtension

java.lang.Object

com.vladsch.flexmark.ext.emoji.EmojiExtension

All Implemented Interfaces:

Formatter.FormatterExtension, HtmlRenderer.HtmlRendererExtension, Parser.ParserExtension, Extension

public class EmojiExtension
extends java.lang.Object
implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension, Formatter.FormatterExtension

Extension for emoji shortcuts using Emoji-Cheat-Sheet.com.

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static DataKey<java.lang.String>	ATTR_ALIGN
static DataKey<java.lang.String>	ATTR_IMAGE_CLASS
static DataKey<java.lang.String>	ATTR_IMAGE_SIZE
static DataKey<java.lang.String>	ROOT_IMAGE_PATH
static DataKey<EmojiImageType>	USE_IMAGE_TYPE
static DataKey<EmojiShortcutType>	USE_SHORTCUT_TYPE
static DataKey<java.lang.Boolean>	USE_UNICODE_FILE_NAMES

Fields inherited from interface com.vladsch.flexmark.util.misc.Extension

EMPTY_LIST

Method Summary

Modifier and Type	Method	Description
static EmojiExtension	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 contains
void	extend(Parser.Builder parserBuilder)	This method is called on all extensions so that they can register their custom processors
void	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.

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_ALIGN

public static final DataKey<java.lang.String> ATTR_ALIGN

ATTR_IMAGE_SIZE

public static final DataKey<java.lang.String> ATTR_IMAGE_SIZE

ATTR_IMAGE_CLASS

public static final DataKey<java.lang.String> ATTR_IMAGE_CLASS

ROOT_IMAGE_PATH

public static final DataKey<java.lang.String> ROOT_IMAGE_PATH

USE_SHORTCUT_TYPE

public static final DataKey<EmojiShortcutType> USE_SHORTCUT_TYPE

USE_IMAGE_TYPE

public static final DataKey<EmojiImageType> USE_IMAGE_TYPE

USE_UNICODE_FILE_NAMES

public static final DataKey<java.lang.Boolean> USE_UNICODE_FILE_NAMES

Method Detail

create

public static EmojiExtension 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 interface Formatter.FormatterExtension

Specified by:

rendererOptions in interface HtmlRenderer.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 interface Parser.ParserExtension

Parameters:

options - option set that will be used for the builder

extend

public void extend(Formatter.Builder formatterBuilder)

Specified by:

extend in interface Formatter.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 interface Parser.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 interface HtmlRenderer.HtmlRendererExtension

Parameters:

htmlRendererBuilder - builder to call back for extension point registration

rendererType - 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)