com.jalios.jcms.taglib
Class MediaTag

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by 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:
Serialized Form

Field Summary
static String MEDIA_DATA
          Request attribute name to retrieve the Data to be displayed, might be null.
static String MEDIA_DESCRIPTION
          Request attribute name to retrieve the description to be displayed, might be null.
static String MEDIA_MAX_HEIGHT
          Request attribute name to retrieve the maximum height of the media file to be displayed.
static String MEDIA_MAX_WIDTH
          Request attribute name to retrieve the maximum width of the media file to be displayed.
static String MEDIA_PATH
          Request attribute name to retrieve the path of the media file to be displayed.
static String REVISION
           
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
MediaTag()
           
 
Method Summary
 int doEndTag()
           
 int doStartTag()
           
static String getMediaTemplatePath(String templateName, Data data)
          Retrieve the path of the JSP suitable to display the specified Data.
static String getMediaTemplatePath(String templateName, String mediaPath, String mediaContentType)
          Retrieve the path of the JSP suitable to display the specified media.
 void includeMediaTemplate()
          Include the JSP suitable to display the specified media.
 void setData(Data data)
           
 void setDescription(String mediaDescription)
          Sets a optionnal description to use in appropriate HTML attribute if any (img alt text, title or such).
 void setFile(File file)
           
 void setFileDoc(FileDocument fileDoc)
           
 void setMaxHeight(int height)
           
 void setMaxWidth(int width)
           
 void setPath(String path)
           
 void setTemplate(String templateName)
          Sets the name of the template to be used by this tag.
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

REVISION

public static final String REVISION
See Also:
Constant Field Values

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:
Constant Field Values

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:
Constant Field Values

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:
Constant Field Values

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:
Constant Field Values

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:
Constant Field Values
Constructor Detail

MediaTag

public MediaTag()
Method Detail

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 optionnal 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)

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
javax.servlet.ServletException

getMediaTemplatePath

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)
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

getMediaTemplatePath

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


Copyright © 2001-2010 Jalios SA. All Rights Reserved.