Interface IPromptQueryConfig_DisplayResolution

public interface IPromptQueryConfig_DisplayResolution
Mixin for a prompt query configuration model that allows the user to define the resolution of generated image or video files, such as e.g. 512x512 or 256x256. It is up to implementations to define which resolutions are supported, and what their identifiers are.

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:displayResolution/> 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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ATTR_DISPLAY_RESOLUTION
    The name of the display resolution attribute.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDisplayResolution()
    Gets the resolution to use for generated files, in the format (width)x(height), such as e.g. 256x256 or 512x512.
    void
    setDisplayResolution(String displayResolution)
    Sets the resolution to use for generated files, in the format (width)x(height), such as e.g. 256x256 or 512x512.

  • Field Details

    • ATTR_DISPLAY_RESOLUTION

      static final String ATTR_DISPLAY_RESOLUTION
      The name of the display resolution 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

    • getDisplayResolution

      String getDisplayResolution()
      Gets the resolution to use for generated files, in the format (width)x(height), such as e.g. 256x256 or 512x512.
      Returns:
      The display resolution.

    • setDisplayResolution

      void setDisplayResolution(String displayResolution)
      Sets the resolution to use for generated files, in the format (width)x(height), such as e.g. 256x256 or 512x512.
      Parameters:
      displayResolution - The display resolution.