Interface IPromptQueryConfig_ImageCompressionQuality


  • public interface IPromptQueryConfig_ImageCompressionQuality
    Mixin for a prompt query configuration model that allows the user to define the compression quality of generated image files, if the image format supports compression, as a percentage value from 0% to 100%.

    Use of this mixin is optional, but ensures a consistent name for the property. When different prompt service handlers use the same property name, switching between different prompt service handlers preserves the configured data.

    See also the <xp:imageCompressionQuality/> Faces component from the http://www.xima.de/taglib/xfc/prompt namespace, which provides a user interface for editing the data defined by this mixin.

    Since:
    8.5.0
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Long getImageCompressionQuality()
      Gets the image compression quality to use for generated image files, between 0 (lowest quality, highest compression) and 100 (highest quality, lowest compression).
      void setImageCompressionQuality​(Long imageCompressionQuality)
      Sets the image compression quality to use for generated image files, between 0 (lowest quality, highest compression) and 100 (highest quality, lowest compression).
    • Field Detail

      • ATTR_IMAGE_COMPRESSION_QUALITY

        static final String ATTR_IMAGE_COMPRESSION_QUALITY
        The name of the image compression quality attribute. If you implement a custom serialization / deserialization, use this name for the attribute to increase compatibility with other prompt service handlers.
        See Also:
        Constant Field Values
    • Method Detail

      • getImageCompressionQuality

        Long getImageCompressionQuality()
        Gets the image compression quality to use for generated image files, between 0 (lowest quality, highest compression) and 100 (highest quality, lowest compression).
        Returns:
        The image compression quality.
      • setImageCompressionQuality

        void setImageCompressionQuality​(Long imageCompressionQuality)
        Sets the image compression quality to use for generated image files, between 0 (lowest quality, highest compression) and 100 (highest quality, lowest compression).
        Parameters:
        imageCompressionQuality - The image compression quality.