Class DefaultThumbnailPolicyFilter

All Implemented Interfaces:
GenericProvider, PluginComponent, PolicyFilter, ThumbnailPolicyFilter, Comparable

public class DefaultThumbnailPolicyFilter extends BasicThumbnailPolicyFilter
Deprecated.
the DefaultThumbnailPolicyFilter will be split to 3 independents ThumbnailPolicyFilter
This class allow users to customize behaviour of widgets by re-writing call-back methods.
Since:
jcms-5.5.0
Author:
Jean-Philippe Encausse
  • Constructor Details

    • DefaultThumbnailPolicyFilter

      public DefaultThumbnailPolicyFilter()
      Deprecated.
  • Method Details

    • createThumbnail

      public boolean createThumbnail(File src, File dest, ImageFormat format, int maxWidth, int maxHeight, String background, boolean square, boolean done)
      Deprecated.
      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
      Overrides:
      createThumbnail in class BasicThumbnailPolicyFilter
      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
      square - 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:
    • isValidImageSize

      public boolean isValidImageSize(File imgFile, long width, long height)
      Deprecated.
      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:
    • supportsThumbnail

      public boolean supportsThumbnail(FileDocument doc)
      Deprecated.
      Parameters:
      doc - the FileDocument to be checked
      Returns:
      true if a thumbnail can be generated for the given document.
      See Also:
    • createThumbnail

      public boolean createThumbnail(FileDocument doc, File dest, ImageFormat format, int maxWidth, int maxHeight, String background, boolean square, boolean done)
      Deprecated.
      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
      Overrides:
      createThumbnail in class BasicThumbnailPolicyFilter
      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
      square - 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:
    • createThumbnail

      public boolean createThumbnail(URL url, File dest, ImageFormat format, int maxWidth, int maxHeight, String background, boolean square, boolean done)
      Deprecated.
      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
      Overrides:
      createThumbnail in class BasicThumbnailPolicyFilter
      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
      square - 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: