org.cyclos.impl.utils

Interface RichTextHandler

public interface RichTextHandler

Contains methods to handle rich text formatting, as well as replacing image URL's with internal tags.

Author:

luis

See Also:

RichText

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.regex.Pattern	TAG_PATTERN
static java.lang.String	URL_TAG_PREFIX
static java.lang.String	URL_TAG_SEPARATOR
static java.lang.String	URL_TAG_SUFFIX

Method Summary

Modifier and Type	Method and Description
java.lang.String	replaceTagsByUrls(java.lang.String html) Replaces internal tags to URLs.
java.lang.String	replaceTagsByUrls(java.lang.String html, User user) Same as replaceTagsByUrls(String) but using the root url and network of the specified user,
java.lang.String	sanitize(java.lang.String html) Sanitizes the given HTML, removing blacklisted tags, correctly closing unclosed tags and removing leading / trailing whitespaces.

Field Detail

URL_TAG_PREFIX

static final java.lang.String URL_TAG_PREFIX

See Also:

Constant Field Values

URL_TAG_SEPARATOR

static final java.lang.String URL_TAG_SEPARATOR

See Also:

Constant Field Values

URL_TAG_SUFFIX

static final java.lang.String URL_TAG_SUFFIX

See Also:

Constant Field Values

TAG_PATTERN

static final java.util.regex.Pattern TAG_PATTERN

Method Detail

replaceTagsByUrls

java.lang.String replaceTagsByUrls(java.lang.String html)

Replaces internal tags to URLs. Should be invoked when converting a data to be sent to a client on an entity model (VO / DTO) from an entity.

See Also:

#replaceUrlsByTags(String)

replaceTagsByUrls

java.lang.String replaceTagsByUrls(java.lang.String html,
                                   User user)

Same as replaceTagsByUrls(String) but using the root url and network of the specified user,

sanitize

java.lang.String sanitize(java.lang.String html)

Sanitizes the given HTML, removing blacklisted tags, correctly closing unclosed tags and removing leading / trailing whitespaces. Administrators are allowed to use iframes and forms, but not regular users. Scripts and style tags are forbidden. Null inputs, as well as empty strings, results in null.