Interface IPromptQueryConfig_AspectRatio

public interface IPromptQueryConfig_AspectRatio
Mixin for a prompt query configuration model that allows the user to define the aspect ratio, such as e.g. 16:9 or 4:3. 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:aspectRatio/> 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_ASPECT_RATIO
    The name of the aspect ratio attribute.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAspectRatio()
    Gets the aspect ratio to use for generated files, in the format (width):(height), such as e.g. 19:9 or 4:3.
    void
    setAspectRatio(String aspectRatio)
    Sets the aspect ratio to use for generated files, in the format (width):(height), such as e.g. 16:9 or 4:3.

  • Field Details

    • ATTR_ASPECT_RATIO

      static final String ATTR_ASPECT_RATIO
      The name of the aspect ratio 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

    • getAspectRatio

      String getAspectRatio()
      Gets the aspect ratio to use for generated files, in the format (width):(height), such as e.g. 19:9 or 4:3.
      Returns:
      The aspect ratio.

    • setAspectRatio

      void setAspectRatio(String aspectRatio)
      Sets the aspect ratio to use for generated files, in the format (width):(height), such as e.g. 16:9 or 4:3.
      Parameters:
      aspectRatio - The aspect ratio.