Package com.jalios.jcms.wysiwyg

Class WysiwygMediasRewriter

  • public class WysiwygMediasRewriter
extends java.lang.Object
    Provides facilities to rewrite object tag in HTML wysiwyg content with content generated by the MediaTag and its template API. 
    html = WysiwygMediasRewriter.rewriteMedias(html)
    It is invoked automatically by WysiwygRenderer through <jalios:wysiwyg> tag, if the following property was defined : 
    wysiwyg.medias-rewrite.enabled: true
    Since:
    jcms-7.1.3 jcms-8.0.2 JCMS-3680

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static boolean canRewrite()
      Check if the current context information required to rewrite a media are available.
      static java.util.Set<FileDocument> extractMedias​(java.lang.String html)
      Find all the "object" tags in the specified html and extract the corresponding FileDocument.
      static java.lang.String renderMedia​(java.lang.String mediaSource, int maxWidth, int maxHeight)
      Render the specified media path using the appropriate MediaTag template .
      static java.lang.String rewriteMedias​(java.lang.String html)
      Find all the "object" tags in the specified html and replace them with a rendering performed by the MediaTag.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • WysiwygMediasRewriter

        public WysiwygMediasRewriter()

    • Method Detail

      • rewriteMedias

        public static java.lang.String rewriteMedias​(java.lang.String html)
        Find all the "object" tags in the specified html and replace them with a rendering performed by the MediaTag.
        Parameters:
        html - the HTML fragment to be modified
        Returns:
        the modified HTML never return null

      • extractMedias

        public static java.util.Set<FileDocument> extractMedias​(java.lang.String html)
        Find all the "object" tags in the specified html and extract the corresponding FileDocument.
        Parameters:
        html - the HTML fragment to be modified
        Returns:
        a set of FileDocument, never return null
        Since:
        JCMS-6258

      • canRewrite

        public static boolean canRewrite()
        Check if the current context information required to rewrite a media are available.

        Depending on the implementation (Tomcat or JspEngine), the requirements may not be the same (current request available, ...).

        Returns:
        true if rewrite can be performed, false otherwise

      • renderMedia

        public static java.lang.String renderMedia​(java.lang.String mediaSource,
                                           int maxWidth,
                                           int maxHeight)
        Render the specified media path using the appropriate MediaTag template .
        Parameters:
        mediaSource - the source of the media : an id, an URL, or a path relative to the webapp
        maxWidth - a maximum width, value is ignored if equals or lower than 0
        maxHeight - a maximum height, value is ignored if equals or lower than 0
        Returns:
        null if media could not be rendered, otherwise the rendering of the JSP