tinymce.html.Entities

Entity encoder class.

Summary

Methods

Name Summary Defined by

decode()

Decodes the specified string, this will replace entities with raw UTF characters.

Entities

encodeAllRaw()

Encoded the specified text with both the attributes and text entities. This function will produce larger text contents since it doesn’t know if the context is within a attribute or text node. This was added for compatibility and is exposed as the DOMUtils.encode function.

Entities

encodeNamed()

Encodes the specified string using named entities. The core entities will be encoded as named ones but all non lower ascii characters will be encoded into named entities.

Entities

encodeNumeric()

Encodes the specified string using numeric entities. The core entities will be encoded as named ones but all non lower ascii characters will be encoded into numeric entities.

Entities

encodeRaw()

Encodes the specified string using raw entities. This means only the required XML base entities will be encoded.

Entities

getEncodeFunc()

Returns an encode function based on the name(s) and it’s optional entities.

Entities

Methods

decode()

decode(text: String): String

Decodes the specified string, this will replace entities with raw UTF characters.

Parameters

  • text (String) - Text to entity decode.

Return value

  • String - Entity decoded string.

encodeAllRaw()

encodeAllRaw(text: String): String

Encoded the specified text with both the attributes and text entities. This function will produce larger text contents since it doesn’t know if the context is within a attribute or text node. This was added for compatibility and is exposed as the DOMUtils.encode function.

Parameters

  • text (String) - Text to encode.

Return value

  • String - Entity encoded text.

encodeNamed()

encodeNamed(text: String, attr: Boolean, entities: Object): String

Encodes the specified string using named entities. The core entities will be encoded as named ones but all non lower ascii characters will be encoded into named entities.

Parameters

  • text (String) - Text to encode.

  • attr (Boolean) - Optional flag to specify if the text is attribute contents.

  • entities (Object) - Optional parameter with entities to use.

Return value

  • String - Entity encoded text.

encodeNumeric()

encodeNumeric(text: String, attr: Boolean): String

Encodes the specified string using numeric entities. The core entities will be encoded as named ones but all non lower ascii characters will be encoded into numeric entities.

Parameters

  • text (String) - Text to encode.

  • attr (Boolean) - Optional flag to specify if the text is attribute contents.

Return value

  • String - Entity encoded text.

encodeRaw()

encodeRaw(text: String, attr: Boolean): String

Encodes the specified string using raw entities. This means only the required XML base entities will be encoded.

Parameters

  • text (String) - Text to encode.

  • attr (Boolean) - Optional flag to specify if the text is attribute contents.

Return value

  • String - Entity encoded text.

getEncodeFunc()

getEncodeFunc(name: String, entities: String): function

Returns an encode function based on the name(s) and it’s optional entities.

Parameters

  • name (String) - Comma separated list of encoders for example named,numeric.

  • entities (String) - Optional parameter with entities to use instead of the built in set.

Return value

  • function - Encode function to be used.