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

public Class EmojiExtension

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.emoji.internal.EmojiDelimiterProcessor, .EmojiJiraRenderer, .EmojiNodeFormatter, .EmojiNodeRenderer, com.vladsch.flexmark.formatter.Formatter, com.vladsch.flexmark.html.HtmlRenderer, com.vladsch.flexmark.parser.Parser, com.vladsch.flexmark.util.data.DataKey, .MutableDataHolder, org.jetbrains.annotations.NotNull
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

Modifier and TypeField and Description
public static final DataKey<String>
ATTR_ALIGN

public static final DataKey<String>
ATTR_IMAGE_CLASS

public static final DataKey<String>
ATTR_IMAGE_SIZE

public static final DataKey<String>
ROOT_IMAGE_PATH

public static final DataKey<EmojiImageType>
USE_IMAGE_TYPE

public static final DataKey<EmojiShortcutType>
USE_SHORTCUT_TYPE

public static final DataKey<Boolean>
USE_UNICODE_FILE_NAMES

Constructor Summary

AccessConstructor and Description
private
EmojiExtension()

Method Summary

Modifier and TypeMethod and Description
public static EmojiExtension
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

ATTR_ALIGNback to summary
public static final DataKey<String> ATTR_ALIGN
ATTR_IMAGE_CLASSback to summary
public static final DataKey<String> ATTR_IMAGE_CLASS
ATTR_IMAGE_SIZEback to summary
public static final DataKey<String> ATTR_IMAGE_SIZE
ROOT_IMAGE_PATHback to summary
public static final DataKey<String> ROOT_IMAGE_PATH
USE_IMAGE_TYPEback to summary
public static final DataKey<EmojiImageType> USE_IMAGE_TYPE
USE_SHORTCUT_TYPEback to summary
public static final DataKey<EmojiShortcutType> USE_SHORTCUT_TYPE
USE_UNICODE_FILE_NAMESback to summary
public static final DataKey<Boolean> USE_UNICODE_FILE_NAMES

Constructor Detail

EmojiExtensionback to summary
private EmojiExtension()

Method Detail

createback to summary
public static EmojiExtension 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