Package com.jalios.jcms.thumbnail
Class AbstractThumbnailPolicyFilterImpl
- java.lang.Object
-
- com.jalios.jcms.policy.AbstractPolicyFilter
-
- com.jalios.jcms.policy.BasicThumbnailPolicyFilter
-
- com.jalios.jcms.thumbnail.AbstractThumbnailPolicyFilterImpl
-
- All Implemented Interfaces:
GenericProvider
,PluginComponent
,PolicyFilter
,ThumbnailPolicyFilter
,java.lang.Comparable
- Direct Known Subclasses:
DefaultImageThumbnailPolicyFilter
,DefaultOpenOfficeThumbnailPolicyFilter
,DefaultOpenXmlThumbnailPolicyFilter
public abstract class AbstractThumbnailPolicyFilterImpl extends BasicThumbnailPolicyFilter
This class allow users to customize behaviour of widgets by re-writing call-back methods.- Since:
- jcms-10.0.5
- Version:
- $Revision: 125705 $
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
REVISION
-
Fields inherited from class com.jalios.jcms.policy.AbstractPolicyFilter
order
-
-
Constructor Summary
Constructors Constructor Description AbstractThumbnailPolicyFilterImpl()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract boolean
createThumbnail(FileDocument doc, java.io.File dest, ImageFormat format, int maxWidth, int maxHeight, java.lang.String background, boolean square, boolean done)
This method is a hook called by Thumbnail tag to generate a thumbnail of the given FileDocument.boolean
createThumbnail(java.io.File src, java.io.File dest, ImageFormat format, int maxWidth, int maxHeight, java.lang.String background, boolean square, boolean done)
This method is a hook called by Thumbnail tag to generate a thumbnail of the given source file.boolean
createThumbnail(java.net.URL url, java.io.File dest, ImageFormat format, int maxWidth, int maxHeight, java.lang.String background, boolean square, boolean done)
This method is a hook called by Thumbnail tag to generate a thumbnail of the given URL.boolean
isValidImageSize(java.io.File imgFile, long width, long height)
boolean
supportsThumbnail(FileDocument doc)
-
Methods inherited from class com.jalios.jcms.policy.BasicThumbnailPolicyFilter
createThumbnail, createThumbnail, createThumbnail, createThumbnail, createThumbnail, createThumbnail, init, init, isValidImageSize, supportsThumbnail
-
Methods inherited from class com.jalios.jcms.policy.AbstractPolicyFilter
compareTo, equals, getOrder, setOrder
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.jalios.jcms.GenericProvider
getLabel, getName, isInitialized
-
-
-
-
Field Detail
-
REVISION
public static final java.lang.String REVISION
- See Also:
- Constant Field Values
-
-
Method Detail
-
createThumbnail
public boolean createThumbnail(java.io.File src, java.io.File dest, ImageFormat format, int maxWidth, int maxHeight, java.lang.String background, boolean square, boolean done)
Description copied from interface:ThumbnailPolicyFilter
This method is a hook called by Thumbnail tag to generate a thumbnail of the given source file.- Specified by:
createThumbnail
in interfaceThumbnailPolicyFilter
- Overrides:
createThumbnail
in classBasicThumbnailPolicyFilter
- Parameters:
src
- source 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 generatebackground
- the background color (eg "FFFFFF") if sets the image dimension will be set maxWidth and maxHeightsquare
- set to true to crop image into a square using the specified width during thumbnail creation.done
- the global plugin createThumbnail() status- Returns:
- true on success, or false if the thumbnail could not be created
- See Also:
ThumbnailPolicyFilter.createThumbnail(File, File, ImageFormat, int, int, String, boolean, boolean)
-
isValidImageSize
public boolean isValidImageSize(java.io.File imgFile, long width, long height)
- Parameters:
imgFile
- the image File being checked (only used for logging)width
- the widht of the image (in pixel)height
- the heigth of the image (in pixel)- Returns:
- true if the given dimension are valid, false otherwise
- See Also:
ThumbnailPolicyFilter.isValidImageSize(File, long, long, boolean)
-
supportsThumbnail
public boolean supportsThumbnail(FileDocument doc)
- Parameters:
doc
- the FileDocument to be checked- Returns:
- true if a thumbnail can be generated for the given document.
- See Also:
ThumbnailPolicyFilter.supportsThumbnail(FileDocument, boolean)
-
createThumbnail
public abstract boolean createThumbnail(FileDocument doc, java.io.File dest, ImageFormat format, int maxWidth, int maxHeight, java.lang.String background, boolean square, boolean done)
Description copied from interface:ThumbnailPolicyFilter
This method is a hook called by Thumbnail tag to generate a thumbnail of the given FileDocument.- Specified by:
createThumbnail
in interfaceThumbnailPolicyFilter
- Overrides:
createThumbnail
in classBasicThumbnailPolicyFilter
- Parameters:
doc
- FileDocument 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 generatebackground
- the background color (eg "FFFFFF") if sets the image dimension will be set maxWidth and maxHeightsquare
- set to true to crop image into a square using the specified width during thumbnail creation.done
- the global plugin createThumbnail() status- Returns:
- true on success, or false if the thumbnail could not be created
- See Also:
ThumbnailPolicyFilter.createThumbnail(FileDocument, File, ImageFormat, int, int, String, boolean, boolean)
-
createThumbnail
public boolean createThumbnail(java.net.URL url, java.io.File dest, ImageFormat format, int maxWidth, int maxHeight, java.lang.String background, boolean square, boolean done)
Description copied from interface:ThumbnailPolicyFilter
This method is a hook called by Thumbnail tag to generate a thumbnail of the given URL.- Specified by:
createThumbnail
in interfaceThumbnailPolicyFilter
- Overrides:
createThumbnail
in classBasicThumbnailPolicyFilter
- Parameters:
url
- the URL 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 generatebackground
- the background color (eg "FFFFFF") if sets the image dimension will be set maxWidth and maxHeightsquare
- set to true to crop image into a square using the specified width during thumbnail creation.done
- the global plugin createThumbnail() status- Returns:
- true on success, or false if the thumbnail could not be created
- See Also:
ThumbnailPolicyFilter.createThumbnail(URL, File, ImageFormat, int, int, String, boolean, boolean)
-
-