Package de.xima.fc.prompt.service.support

Interface IPromptQueryConfig_ImageFormat

  • public interface IPromptQueryConfig_ImageFormat
    Mixin for a prompt query configuration model that allows the user to define the format of generated image files, such as e.g. png or jpeg. It is up to implementations to define which image formats are supported, and what their identifiers are. But see CommonImageFormat for standard names of common image formats. We encourage implementations to use these common names to increase interoperability between different prompt service implementations.

    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:imageFormat/> 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
    See Also:
    CommonImageFormat

    • Field Detail

      • ATTR_IMAGE_FORMAT

        static final String ATTR_IMAGE_FORMAT
        The name of the image format 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

      • getImageFormat

        String getImageFormat()
        Gets the format to use for generated image files, such as e.g. png or jpeg.
        Returns:
        The image format.

      • setImageFormat

        void setImageFormat​(String imageFormat)
        Sets the format to use for generated image files, such as e.g. png or jpeg.
        Parameters:
        imageFormat - The image format.