Class MediaTag

java.lang.Object
javax.servlet.jsp.tagext.TagSupport
com.jalios.jcms.taglib.MediaTag
All Implemented Interfaces:
Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class MediaTag extends javax.servlet.jsp.tagext.TagSupport
Print the HTML required to provide a media player for any file.
Since:
jcms-6.1
See Also:
  • Field Details

    • MEDIA_PATH

      public static final String MEDIA_PATH
      Request attribute name to retrieve the path of the media file to be displayed. String path = (String) request.getAttribute(MediaTag.MEDIA_PATH);
      See Also:
    • MEDIA_MAX_WIDTH

      public static final String MEDIA_MAX_WIDTH
      Request attribute name to retrieve the maximum width of the media file to be displayed. int maxWidth = Util.toInt(request.getAttribute(MediaTag.MEDIA_MAX_WIDTH), 320);
      See Also:
    • MEDIA_MAX_HEIGHT

      public static final String MEDIA_MAX_HEIGHT
      Request attribute name to retrieve the maximum height of the media file to be displayed. int maxHeight = Util.toInt(request.getAttribute(MediaTag.MEDIA_MAX_HEIGHT), 240);
      See Also:
    • MEDIA_DATA

      public static final String MEDIA_DATA
      Request attribute name to retrieve the Data to be displayed, might be null. Data data = (Data) request.getAttribute(MediaTag.MEDIA_DATA);
      See Also:
    • MEDIA_DESCRIPTION

      public static final String MEDIA_DESCRIPTION
      Request attribute name to retrieve the description to be displayed, might be null. String mediaDescription = (String) request.getAttribute(MediaTag.MEDIA_DESCRIPTION);
      Since:
      jcms-7.1.2 (improvement JCMS-3003)
      See Also:
    • HTML_ATTRIBUTES

      public static final String HTML_ATTRIBUTES
      Request attribute name to retrieve the html attributes to be displayed, might be null. String htmlAttributes = (String) request.getAttribute(MediaTag.HTML_ATTRIBUTES);
      Since:
      jcms-10.0.5
      See Also:
    • CSS

      public static final String CSS
      Request attribute name to retrieve the css classes to be displayed, might be null. String css = (String) request.getAttribute(MediaTag.CSS);
      Since:
      jcms-10.0.6
      See Also:
  • Constructor Details

    • MediaTag

      public MediaTag()
  • Method Details

    • setData

      public void setData(Data data)
    • setFileDoc

      public void setFileDoc(FileDocument fileDoc)
    • setPath

      public void setPath(String path)
    • setFile

      public void setFile(File file)
    • setMaxWidth

      public void setMaxWidth(int width)
    • setMaxHeight

      public void setMaxHeight(int height)
    • setTemplate

      public void setTemplate(String templateName)
      Sets the name of the template to be used by this tag.

      See properties media.template.{templateName}.{type-mime} in jcms.prop for example on how to define new templates.

      Parameters:
      templateName - a template name (default value is "default").
      Since:
      jcms-6.1.2 (fix bug JCMS-2105)
    • setDescription

      public void setDescription(String mediaDescription)
      Sets a optional description to use in appropriate HTML attribute if any (img alt text, title or such).

      If empty, the data's name or the media's path is used.

      Parameters:
      mediaDescription - a short description for use in HTML attributes
      Since:
      jcms-7.1.2 (improvement JCMS-3003)
    • setHtmlAttributes

      public void setHtmlAttributes(String htmlAttributes)
      Sets optional html attributes tag to the main html attribute provided by the media template jsp (Video tag or other html5 tag)
      Parameters:
      htmlAttributes - a String representing additional html attributes to add to the produced media tag
      Since:
      jcms-10.0.6
    • setCss

      public void setCss(String css)
      Sets optional css classes to the main html attribute provided by the media template jsp
      Parameters:
      css - a String representing additional html attributes to add to the produced media tag
      Since:
      jcms-10.0.6
    • doStartTag

      public int doStartTag() throws javax.servlet.jsp.JspException
      Specified by:
      doStartTag in interface javax.servlet.jsp.tagext.Tag
      Overrides:
      doStartTag in class javax.servlet.jsp.tagext.TagSupport
      Throws:
      javax.servlet.jsp.JspException
    • doEndTag

      public int doEndTag()
      Specified by:
      doEndTag in interface javax.servlet.jsp.tagext.Tag
      Overrides:
      doEndTag in class javax.servlet.jsp.tagext.TagSupport
    • includeMediaTemplate

      public void includeMediaTemplate() throws javax.servlet.ServletException, IOException
      Include the JSP suitable to display the specified media.
      Throws:
      IOException - if such an exception occurs
      javax.servlet.ServletException - if such an exception occurs
      See Also:
    • getMediaTemplatePath

      @Deprecated public static String getMediaTemplatePath(String templateName, String mediaPath, String mediaContentType)
      Retrieve the path of the JSP suitable to display the specified media.
      Parameters:
      templateName - the name of the template to retrieve
      mediaPath - the path of the media to display, relative to the webapp root (eg. upload/docs/myfile.ext) can also be an URL such as https://www.youtube.com/watch?v=abc (if supported in template declarations)
      mediaContentType - the content type of the media to display (eg. image/jpeg)
      Returns:
      the relative path of the Media JSP template to use to display the specified media, may return null if no suitable template was find for the media
    • getMediaTemplatePath

      @Deprecated public static String getMediaTemplatePath(String templateName, Data data)
      Retrieve the path of the JSP suitable to display the specified Data.
      Parameters:
      templateName - the name of the template to retrieve
      data - the Data to display
      Returns:
      the relative path of the Media JSP template to use to display the specified Data