Magnolia 5.3 reached end of life on June 30, 2017. This branch is no longer supported, see End-of-life policy.

Page tree
Skip to end of metadata
Go to start of metadata

Image provider is a component that renders images used in apps. It generates the portrait image at the bottom of the action bar and the thumbnails for the thumbnail view. 

Here is an example image provider definition that uses default classes.

Node name

Value

 imageProvider

 

 class

info.magnolia.ui.imageprovider.definition.ConfiguredImageProviderDefinition

 imageProviderClass

info.magnolia.ui.imageprovider.DefaultImageProvider

 originalImageNodeName

jcr:content

Properties:

  • class: Image provider definition class that reads the configuration properties and can supply additional parameters to the image provider class. The definition class must implement the ImageProviderDefinition  interface. Set the value to a fully-qualified class name.
  • imageProvideClass: Actual implementation that generates thumbnail images. The class must implement the  ImageProvider  interface. You can use  DefaultImageProvider which provides images for objects of MIME type image/* and delegates to the Imaging module to generate and store the images.
  • imageExtension: Optional. Extension used to deliver the image. Default is png.
  • imagingServletPath: Optional. By default the images are created by the imaging servlet which serves them from path .imaging.
  • originalImageNodeName: Optional. Name of the JCR node where the original source image is stored. For example, if the file upload field on your form stores the image in a node named photo set the value of the originalImageNodeName to photo. Default value is originalImage.

Here are the image generator configurations in the Imaging module that are used by DefaultImageProvider.

Node name

Value

 modules 

 imaging

 

 config

 

 generators

 

 portrait

 

 outputFormat

 

 operations

 

 parameterProviderFactory

 

 class

info.magnolia.imaging.operations.ImageOperationChain

 thumbnail

 

 outputFormat

 

 operations

 

 parameterProviderFactory

 

 class

info.magnolia.imaging.operations.ImageOperationChain