Interface NamedImageTransformer


  • @ProviderType
    public interface NamedImageTransformer
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String PROP_NAME
      The OSGi config property used to identify the named transform.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Map<String,​org.apache.sling.api.resource.ValueMap> getImageTransforms()  
      String getTransformName()
      Returns the name of this transform as defined in this instance's OSGi configuration.
      com.day.image.Layer transform​(com.day.image.Layer layer)
      Transforms the param layer using all the parameterized image transformers defined in this instances OSGi configuration.
    • Field Detail

      • PROP_NAME

        static final String PROP_NAME
        The OSGi config property used to identify the named transform.
        See Also:
        Constant Field Values
    • Method Detail

      • transform

        com.day.image.Layer transform​(com.day.image.Layer layer)
        Transforms the param layer using all the parameterized image transformers defined in this instances OSGi configuration.
        Parameters:
        layer - the image layer to transform
        Returns:
        the transform image layer; or if no modifications are possible (invalid named transforms/named transform parameters) the layer unmodified
      • getTransformName

        String getTransformName()
        Returns the name of this transform as defined in this instance's OSGi configuration. The transform name is also used to construct URLs for the NamedTransformImageServlet
        Returns:
        the transform name
      • getImageTransforms

        Map<String,​org.apache.sling.api.resource.ValueMap> getImageTransforms()
        Returns:
        the ImageTransforms types and their params for this Named Image Transform