Package com.jalios.jcms.wysiwyg

Class WysiwygRenderer

java.lang.Object

com.jalios.jcms.wysiwyg.WysiwygRenderer

All Implemented Interfaces:

JcmsConstants, JaliosConstants

public final class WysiwygRenderer
extends java.lang.Object
implements JcmsConstants

This class contains a set of utility static methods to process wysiwyg text.

Since:

jcms-5.7.0

Field Summary

Fields inherited from interface com.jalios.util.JaliosConstants

CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, CLASS_PROPERTY, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CS_TYPOLOGY_ROOT_CAT_VID, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DATA_DIRECTORY, DEFAULT_PHOTO_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, IS_IN_FRONT_OFFICE, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JCMS_TOASTR_COLLECTION, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, ORGANIZATION_ROOT_GROUP_PROP, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_MINI, PHOTO_MINI_HEIGHT, PHOTO_MINI_PROP_PREFIX, PHOTO_MINI_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, RAW_CONTENT_ICON_PREFIX, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SECURITY_LOG_FILE, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_DIR, STORE_XML, SUCCESS_MSG, SVG_ICON_PREFIX, SVGINLINE_ICON_PREFIX, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, UPLOAD_PERMISSION_COUNT_PROP_PREFIX, UPLOAD_PERMISSION_SIZE_PROP_PREFIX, VID_LOGGED_MEMBER, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Method Summary

Modifier and Type	Method	Description
static java.lang.String	getWysiwygEditorInfosAsJson(java.lang.String jhtml, InsertionContext context)	Retrieve the information used to initialize the WYSIWYG editor.
static java.lang.String	processWysiwyg(java.lang.String wysiwyg, java.util.Locale locale)	Render the specified Wysiwyg/JHTML source data into a HTML suitable for presentation to the end user.
static java.lang.String	processWysiwyg(java.lang.String wysiwyg, java.util.Locale locale, WysiwygRenderingHints hints)	Render the specified Wysiwyg/JHTML source data into a HTML suitable for presentation to the end user.
static java.lang.String	processWysiwygBaseUrl(java.lang.String wysiwyg, java.util.Locale locale)	Replace the baseUrl pattern with the current base URL.
static java.lang.String	relativeToAbsoluteAnchors(java.lang.String contentHtml, java.lang.String currentUrl)	Convert all anchor URLs inside the specified HTML content into absolute URL.

Methods inherited from class java.lang.Object

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

Method Detail

processWysiwyg

public static java.lang.String processWysiwyg(java.lang.String wysiwyg,
                                              java.util.Locale locale)

Render the specified Wysiwyg/JHTML source data into a HTML suitable for presentation to the end user.

Parameters:

wysiwyg - the processed wysiwyg

locale - the userLocale

Returns:

the wysiwyg text processed

processWysiwyg

public static java.lang.String processWysiwyg(java.lang.String wysiwyg,
                                              java.util.Locale locale,
                                              WysiwygRenderingHints hints)

Render the specified Wysiwyg/JHTML source data into a HTML suitable for presentation to the end user.

Parameters:

wysiwyg - the processed wysiwyg

locale - the userLocale

hints - the rendering options to use, if null, the default options will be used.

Returns:

the wysiwyg text processed

Since:

jcms-10.0.0

processWysiwygBaseUrl

public static java.lang.String processWysiwygBaseUrl(java.lang.String wysiwyg,
                                                     java.util.Locale locale)

Replace the baseUrl pattern with the current base URL.

The pattern \${?baseUrl}? is replaced with the current base URL, or the default channel base URL when rendering occurs outside an http request.

Parameters:

wysiwyg - the wysiwyg text

locale - the current user Locale

Returns:

the wysiwyg text, modified if it was needed

relativeToAbsoluteAnchors

public static java.lang.String relativeToAbsoluteAnchors(java.lang.String contentHtml,
                                                         java.lang.String currentUrl)

Convert all anchor URLs inside the specified HTML content into absolute URL.

Uses the specified URL as prefix of relative URL.

Parameters:

contentHtml - the HTML content in which to look for anchor

currentUrl - the current request URL

Returns:

the modified content

getWysiwygEditorInfosAsJson

public static java.lang.String getWysiwygEditorInfosAsJson(java.lang.String jhtml,
                                                           InsertionContext context)

Retrieve the information used to initialize the WYSIWYG editor.

Parameters:

jhtml - JHTML content to parse

context - Context used to retrieve the information related to the unifiedinsert plugin

Returns:

String in JSON format