Interface IPromptQueryConfig_ImageBackground

public interface IPromptQueryConfig_ImageBackground
Mixin for a prompt query configuration model that allows the user to define the background of generated image files, such as e.g. opaque or transparent. It is up to implementations to define which backgrounds are supported, and what their identifiers are. But see CommonImageBackground for standard names of common image backgrounds. 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 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:imageBackground/> 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:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ATTR_IMAGE_BACKGROUND
    The name of the image background attribute.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getImageBackground()
    Gets the background to use for generated image files, such as e.g. opaque or transparent.
    void
    setImageBackground(String imageBackground)
    Sets the background to use for generated image files, such as e.g. opaque or transparent.

  • Field Details

    • ATTR_IMAGE_BACKGROUND

      static final String ATTR_IMAGE_BACKGROUND
      The name of the image background attribute. If you implement a custom serialization / deserialization, use this name for the attribute to increase compatibility with other prompt service handlers.
      See Also:

  • Method Details

    • getImageBackground

      String getImageBackground()
      Gets the background to use for generated image files, such as e.g. opaque or transparent.
      Returns:
      The image background.

    • setImageBackground

      void setImageBackground(String imageBackground)
      Sets the background to use for generated image files, such as e.g. opaque or transparent.
      Parameters:
      imageBackground - The image background.