Class BasicThumbnailPolicyFilter

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String REVISION  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean createThumbnail​(FileDocument doc, java.io.File dest, ImageFormat format, int maxWidth, int maxHeight, boolean done)  
      boolean createThumbnail​(FileDocument doc, java.io.File dest, ImageFormat format, int maxWidth, int maxHeight, java.lang.String background, boolean done)  
      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, boolean done)  
      boolean createThumbnail​(java.io.File src, java.io.File dest, ImageFormat format, int maxWidth, int maxHeight, java.lang.String background, boolean done)  
      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, boolean done)  
      boolean createThumbnail​(java.net.URL url, java.io.File dest, ImageFormat format, int maxWidth, int maxHeight, java.lang.String background, boolean done)  
      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 init​(Plugin plugin)
      Initialize the component with the given plugin configuration
      void init​(java.lang.String providerName, JProperties subProperties)
      this method is called on provider's initialization
      boolean isValidImageSize​(java.io.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 java.lang.Object

        clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface java.lang.Comparable

        compareTo
    • 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)
      • init

        public void init​(java.lang.String providerName,
                         JProperties subProperties)
        Description copied from interface: GenericProvider
        this method is called on provider's initialization
        Specified by:
        init in interface GenericProvider
        Parameters:
        providerName - the name of the provider, from class configuration property
        subProperties - the properties with the same prefix than the property describing the provider class
      • createThumbnail

        public boolean createThumbnail​(java.io.File src,
                                       java.io.File dest,
                                       ImageFormat format,
                                       int maxWidth,
                                       int maxHeight,
                                       boolean done)
      • createThumbnail

        public boolean createThumbnail​(FileDocument doc,
                                       java.io.File dest,
                                       ImageFormat format,
                                       int maxWidth,
                                       int maxHeight,
                                       boolean done)
      • createThumbnail

        public boolean createThumbnail​(java.net.URL url,
                                       java.io.File dest,
                                       ImageFormat format,
                                       int maxWidth,
                                       int maxHeight,
                                       boolean done)
      • createThumbnail

        public boolean createThumbnail​(java.io.File src,
                                       java.io.File dest,
                                       ImageFormat format,
                                       int maxWidth,
                                       int maxHeight,
                                       java.lang.String background,
                                       boolean done)
      • createThumbnail

        public boolean createThumbnail​(FileDocument doc,
                                       java.io.File dest,
                                       ImageFormat format,
                                       int maxWidth,
                                       int maxHeight,
                                       java.lang.String background,
                                       boolean done)
      • createThumbnail

        public boolean createThumbnail​(java.net.URL url,
                                       java.io.File dest,
                                       ImageFormat format,
                                       int maxWidth,
                                       int maxHeight,
                                       java.lang.String background,
                                       boolean done)
      • 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 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
        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:
        ThumbnailPolicyFilter.createThumbnail(File, File, ImageFormat, int, int, String, boolean, boolean)
      • isValidImageSize

        public boolean isValidImageSize​(java.io.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)
      • createThumbnail

        public 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 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
        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:
        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 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
        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:
        ThumbnailPolicyFilter.createThumbnail(URL, File, ImageFormat, int, int, String, boolean, boolean)