com.jalios.jcms.policy
Class BasicThumbnailPolicyFilter

java.lang.Object
  extended by com.jalios.jcms.policy.AbstractPolicyFilter
      extended by com.jalios.jcms.policy.BasicThumbnailPolicyFilter
All Implemented Interfaces:
PluginComponent, PolicyFilter, ThumbnailPolicyFilter, Comparable
Direct Known Subclasses:
DefaultThumbnailPolicyFilter

public class BasicThumbnailPolicyFilter
extends AbstractPolicyFilter
implements ThumbnailPolicyFilter, PluginComponent

This class allow users to customize behaviour of widgets by re-writing call-back methods.

Since:
jcms-5.5.0
Version:
$Revision: 25477 $
Author:
Jean-Philippe Encausse
See Also:
ThumbnailPolicyFilter

Field Summary
static String REVISION
           
 
Fields inherited from class com.jalios.jcms.policy.AbstractPolicyFilter
order
 
Constructor Summary
BasicThumbnailPolicyFilter()
           
 
Method Summary
 boolean createThumbnail(FileDocument doc, File dest, ImageFormat format, int maxWidth, int maxHeight, boolean done)
           
 boolean createThumbnail(FileDocument doc, File dest, ImageFormat format, int maxWidth, int maxHeight, String background, boolean done)
          This method is a hook called by Thumbnail tag to generate a thumbnail of the given FileDocument.
 boolean createThumbnail(File src, File dest, ImageFormat format, int maxWidth, int maxHeight, boolean done)
           
 boolean createThumbnail(File src, File dest, ImageFormat format, int maxWidth, int maxHeight, String background, boolean done)
          This method is a hook called by Thumbnail tag to generate a thumbnail of the given source file.
 boolean createThumbnail(URL url, File dest, ImageFormat format, int maxWidth, int maxHeight, boolean done)
           
 boolean createThumbnail(URL url, File dest, ImageFormat format, int maxWidth, int maxHeight, String background, boolean done)
          This method is a hook called by Thumbnail tag to generate a thumbnail of the given URL.
 boolean init(Plugin plugin)
          Initialize the component with the given plugin configuration
 boolean isValidImageSize(File imgFile, long width, long height, boolean jcms)
          Checks if the given dimension are below the limit above which we do not generate thumbnails
 boolean supportsThumbnail(FileDocument doc, boolean jcms)
          Returns true if a thumbnail can be generated for the given document.
 
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 java.lang.Comparable
compareTo
 

Field Detail

REVISION

public static final String REVISION
See Also:
Constant Field Values
Constructor Detail

BasicThumbnailPolicyFilter

public BasicThumbnailPolicyFilter()
Method Detail

init

public boolean init(Plugin plugin)
Description copied from interface: PluginComponent
Initialize the component with the given plugin configuration

Specified by:
init in interface PluginComponent
Parameters:
plugin - the calling plugin
Returns:
true if the component has been correctly initialized.
Since:
jcms-5.7.1
See Also:
PluginComponent.init(Plugin)

createThumbnail

public boolean createThumbnail(File src,
                               File dest,
                               ImageFormat format,
                               int maxWidth,
                               int maxHeight,
                               boolean done)

createThumbnail

public boolean createThumbnail(FileDocument doc,
                               File dest,
                               ImageFormat format,
                               int maxWidth,
                               int maxHeight,
                               boolean done)

createThumbnail

public boolean createThumbnail(URL url,
                               File dest,
                               ImageFormat format,
                               int maxWidth,
                               int maxHeight,
                               boolean done)

createThumbnail

public boolean createThumbnail(File src,
                               File dest,
                               ImageFormat format,
                               int maxWidth,
                               int maxHeight,
                               String background,
                               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 interface ThumbnailPolicyFilter
Parameters:
src - source file of which to create a thumbnail
dest - destination file (the thumbnail to generate)
format - the format of the file to generate as requested by the ThumbnailTag
maxWidth - the maximum width of the thumbnail to generate
maxHeight - the maximum height of the thumbnail to generate
background - the background color (eg "FFFFFF") if sets the image dimension will be set maxWidth and maxHeight
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)

isValidImageSize

public boolean isValidImageSize(File imgFile,
                                long width,
                                long height,
                                boolean jcms)
Description copied from interface: ThumbnailPolicyFilter
Checks if the given dimension are below the limit above which we do not generate thumbnails

Specified by:
isValidImageSize in interface ThumbnailPolicyFilter
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)
jcms - the value computed by previous policy filter or the default jcms value if no filter has been invoked yet
Returns:
true if the given dimension are valid, false otherwise
See Also:
ThumbnailPolicyFilter.isValidImageSize(File, long, long, boolean)

supportsThumbnail

public boolean supportsThumbnail(FileDocument doc,
                                 boolean jcms)
Description copied from interface: ThumbnailPolicyFilter
Returns true if a thumbnail can be generated for the given document. This method is called as an extension of FileDocument.supportsThumbnail().

Specified by:
supportsThumbnail in interface ThumbnailPolicyFilter
Parameters:
doc - the FileDocument to be checked
jcms - the value computed by previous policy filter or the default jcms value if no filter has been invoked yet
Returns:
true if a thumbnail can be generated for the given document.
See Also:
ThumbnailPolicyFilter.supportsThumbnail(FileDocument, boolean)

createThumbnail

public boolean createThumbnail(FileDocument doc,
                               File dest,
                               ImageFormat format,
                               int maxWidth,
                               int maxHeight,
                               String background,
                               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 interface ThumbnailPolicyFilter
Parameters:
doc - FileDocument of which to create a thumbnail
dest - destination file (the thumbnail to generate)
format - the format of the file to generate as requested by the ThumbnailTag
maxWidth - the maximum width of the thumbnail to generate
maxHeight - the maximum height of the thumbnail to generate
background - the background color (eg "FFFFFF") if sets the image dimension will be set maxWidth and maxHeight
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)

createThumbnail

public boolean createThumbnail(URL url,
                               File dest,
                               ImageFormat format,
                               int maxWidth,
                               int maxHeight,
                               String background,
                               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 interface ThumbnailPolicyFilter
Parameters:
url - the URL of which to create a thumbnail
dest - destination file (the thumbnail to generate)
format - the format of the file to generate as requested by the ThumbnailTag
maxWidth - the maximum width of the thumbnail to generate
maxHeight - the maximum height of the thumbnail to generate
background - the background color (eg "FFFFFF") if sets the image dimension will be set maxWidth and maxHeight
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)


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