com.jalios.jcms.taglib
Class ThumbnailTag
java.lang.Object
javax.servlet.jsp.tagext.TagSupport
javax.servlet.jsp.tagext.BodyTagSupport
com.jalios.jcms.taglib.ThumbnailTag
- All Implemented Interfaces:
- JcmsConstants, JaliosConstants, Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.Tag
public class ThumbnailTag
- extends javax.servlet.jsp.tagext.BodyTagSupport
- implements JcmsConstants
This tags add possibily to create and display a thumbnail of an image.
- Since:
- jcms-5.5.0
- Version:
- $Revision: 21541 $
- Author:
- Olivier Jaquemet
- See Also:
- Serialized Form
Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport |
bodyContent |
Fields inherited from class javax.servlet.jsp.tagext.TagSupport |
id, pageContext |
Fields inherited from interface com.jalios.jcms.JcmsConstants |
ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, CRYPT_MD5, CRYPT_UNDEFINED, CRYPT_UNIX, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DAILY_MAIL_ALERT, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, ICON_ARCHIVE, ICON_LOCK, ICON_LOCK_STRONG, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, MONTHLY_MAIL_ALERT, NO_MAIL_ALERT, OP_CREATE, OP_DEEP_COPY, OP_DEEP_DELETE, OP_DELETE, OP_MERGE, OP_UPDATE, PDATE_SEARCH, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_WIDTH, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_WIDTH, PHOTO_TINY_HEIGHT, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WEEKLY_MAIL_ALERT, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML |
Fields inherited from interface javax.servlet.jsp.tagext.BodyTag |
EVAL_BODY_BUFFERED, EVAL_BODY_TAG |
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 |
Method Summary |
static File |
buildThumbnail(File srcFile,
int width,
int height,
File defaultFile)
Returns a Thumbnail for the given path. |
static String |
buildThumbnail(String path,
int width,
int height,
String defaultPath)
Returns a Thumbnail for the given path. |
protected void |
clean()
|
static boolean |
createImageThumbnail(File imageFile,
File dest,
ImageFormat format,
int maxWidth,
int maxHeight)
This method creates a thumbnail of the given image source file. |
static boolean |
createOpenOfficeThumbnail(File docFile,
File dest,
ImageFormat format,
int maxWidth,
int maxHeight)
This method creates a thumbnail of the given Open Office file. |
static boolean |
createOpenXmlThumbnail(File docFile,
File dest,
ImageFormat format,
int maxWidth,
int maxHeight)
This method creates a thumbnail of the given OpenXml file. |
static String |
createThumbnailFromSessionAttribute(String sessionAttrName)
|
static boolean |
createThumbnailNow(FileDocument fileDoc,
File srcFile,
URL url,
ImageFormat format,
int maxWidth,
int maxHeight,
File destFile)
This method create a thumbnail of one of the three source given using the
options passed as parameters ("now" as opposed to generation when going through ajax}. |
int |
doAfterBody()
|
int |
doEndTag()
|
int |
doStartTag()
|
void |
setAjaxLoadingImage(String ajaxLoadingImage)
|
void |
setAlt(String alt)
|
void |
setCss(String css)
|
void |
setDestination(String path)
|
void |
setFile(File file)
|
void |
setFileDoc(FileDocument fd)
|
void |
setForceUpdate(boolean forceUpdate)
|
void |
setFormat(String format)
|
void |
setHeight(int height)
|
void |
setHtmlAttributes(String htmlAttributes)
|
void |
setPath(String path)
|
void |
setUrl(String purl)
|
void |
setUseAjaxLoading(boolean useAjaxLoading)
|
void |
setWidth(int width)
|
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport |
doInitBody, getBodyContent, getPreviousOut, release, setBodyContent |
Methods inherited from class javax.servlet.jsp.tagext.TagSupport |
findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, resetCustomAttributes, setId, setPageContext, setParent, setValue |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface javax.servlet.jsp.tagext.Tag |
getParent, setPageContext, setParent |
REVISION
public static final String REVISION
- See Also:
- Constant Field Values
MAX_THUMB_SIZE
public static final int MAX_THUMB_SIZE
- See Also:
- Constant Field Values
MIN_THUMB_SIZE
public static final int MIN_THUMB_SIZE
- See Also:
- Constant Field Values
ThumbnailTag
public ThumbnailTag()
clean
protected void clean()
setFileDoc
public void setFileDoc(FileDocument fd)
setFile
public void setFile(File file)
setPath
public void setPath(String path)
setUrl
public void setUrl(String purl)
setFormat
public void setFormat(String format)
setWidth
public void setWidth(int width)
setHeight
public void setHeight(int height)
setDestination
public void setDestination(String path)
setForceUpdate
public void setForceUpdate(boolean forceUpdate)
setAlt
public void setAlt(String alt)
setCss
public void setCss(String css)
setHtmlAttributes
public void setHtmlAttributes(String htmlAttributes)
setUseAjaxLoading
public void setUseAjaxLoading(boolean useAjaxLoading)
setAjaxLoadingImage
public void setAjaxLoadingImage(String ajaxLoadingImage)
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.BodyTagSupport
- Throws:
javax.servlet.jsp.JspException
doEndTag
public int doEndTag()
throws javax.servlet.jsp.JspException
- Specified by:
doEndTag
in interface javax.servlet.jsp.tagext.Tag
- Overrides:
doEndTag
in class javax.servlet.jsp.tagext.TagSupport
- Throws:
javax.servlet.jsp.JspException
doAfterBody
public int doAfterBody()
throws javax.servlet.jsp.JspException
- Specified by:
doAfterBody
in interface javax.servlet.jsp.tagext.BodyTag
- Specified by:
doAfterBody
in interface javax.servlet.jsp.tagext.IterationTag
- Overrides:
doAfterBody
in class javax.servlet.jsp.tagext.BodyTagSupport
- Throws:
javax.servlet.jsp.JspException
createThumbnailFromSessionAttribute
public static String createThumbnailFromSessionAttribute(String sessionAttrName)
throws Exception
- Parameters:
sessionAttrName
- the name of session attribute Map object in which all options were stored
- Returns:
- relative thumbnail path if the thumbnail was created, null otherwise
- Throws:
Exception
- if option 'urlStr' (from option map) could not be converted to URL
buildThumbnail
public static File buildThumbnail(File srcFile,
int width,
int height,
File defaultFile)
- Returns a Thumbnail for the given path. If thumbnail do not exists then create it.
- Parameters:
srcFile
- the original filewidth
- target max widthheight
- target max widthdefaultFile
- the default file to use if thumbnail do not exists
- Returns:
- File the thumbnail file
buildThumbnail
public static String buildThumbnail(String path,
int width,
int height,
String defaultPath)
- Returns a Thumbnail for the given path. If thumbnail do not exists then create it.
- Parameters:
path
- Relative path to the original filewidth
- target max widthheight
- target max widthdefaultPath
- the default image to use if thumbnail do not exists
- Returns:
- String relative path to the thumbnail
createThumbnailNow
public static boolean createThumbnailNow(FileDocument fileDoc,
File srcFile,
URL url,
ImageFormat format,
int maxWidth,
int maxHeight,
File destFile)
- This method create a thumbnail of one of the three source given using the
options passed as parameters ("now" as opposed to generation when going through ajax}.
Possible sources are (only of must be passed, other must be null) :
- Parameters:
fileDoc
- a FileDocument
of which to create thumbnailsrcFile
- a File
of which to create thumbnailurl
- an URL
of which to create thumbnail
Thumbnail options are (all of them must be specified)format
- the ImageFormat
of the file to generatemaxWidth
- the maximum width of the thumbnail to generatemaxHeight
- the maximum height of the thumbnail to generatedestFile
- destination file (of the thumbnail to generate)
- Returns:
- true on success, or false if the thumbnail could not be created
- See Also:
PolicyManager.createThumbnail(FileDocument, File, ImageFormat, int, int)
,
PolicyManager.createThumbnail(File, File, ImageFormat, int, int)
,
PolicyManager.createThumbnail(URL, File, ImageFormat, int, int)
createImageThumbnail
public static boolean createImageThumbnail(File imageFile,
File dest,
ImageFormat format,
int maxWidth,
int maxHeight)
- This method creates a thumbnail of the given image source file.
- Parameters:
imageFile
- image file of which to create a thumbnaildest
- destination file (the thumbnail to generate)format
- the format of the file to generate as requested by the ThumbnailTagmaxWidth
- the maximum width of the thumbnail to generatemaxHeight
- the maximum height of the thumbnail to generate
- Returns:
- true on success, or false if the thumbnail could not be created
- See Also:
ImageUtil.createThumbnail(File, ImageFormat, int, int)
createOpenOfficeThumbnail
public static boolean createOpenOfficeThumbnail(File docFile,
File dest,
ImageFormat format,
int maxWidth,
int maxHeight)
- This method creates a thumbnail of the given Open Office file.
- Parameters:
docFile
- Open Office file of which to create a thumbnaildest
- destination file (the thumbnail to generate)format
- the format of the file to generate as requested by the ThumbnailTagmaxWidth
- the maximum width of the thumbnail to generatemaxHeight
- the maximum height of the thumbnail to generate
- Returns:
- true on success, or false if the thumbnail could not be created
- See Also:
ImageUtil.createThumbnail(File, ImageFormat, int, int)
createOpenXmlThumbnail
public static boolean createOpenXmlThumbnail(File docFile,
File dest,
ImageFormat format,
int maxWidth,
int maxHeight)
- This method creates a thumbnail of the given OpenXml file.
- Parameters:
docFile
- Open Office file of which to create a thumbnaildest
- destination file (the thumbnail to generate)format
- the format of the file to generate as requested by the ThumbnailTagmaxWidth
- the maximum width of the thumbnail to generatemaxHeight
- the maximum height of the thumbnail to generate
- Returns:
- true on success, or false if the thumbnail could not be created
- See Also:
ImageUtil.createThumbnail(File, ImageFormat, int, int)
Copyright © 2001-2007 Jalios SA. All Rights Reserved.