Interface IPromptQueryConfig_SingleImageInput

public interface IPromptQueryConfig_SingleImageInput
Mixin for a query connection configuration model that allows the user to configure whether the query accepts an image file as a file input parameter. There are three possible states: does not accept a file, accepts an optional file, or requires a file. Usually configurable via a tri-state checkbox or select widget in the user interface.

The query may also accept other files in addition to the single image file. It is up to implementations to define where the image file is stored in the list of file inputs. If the query does not allow other files, implementations are encouraged to use a file list descriptor with a single file value descriptor for the DEFAULT_FILE_KEY.

See also the <xp:singleImageInput/> 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_SINGLE_IMAGE_INPUT
    The name of the single image input attribute.

  • Method Summary

    Modifier and Type
    Method
    Description
    SingularFileMode
    getSingleImageInput()
    Gets whether an image file is allowed as a file input parameter for the prompt query.
    void
    setSingleImageInput(SingularFileMode singleImageInput)
    Sets whether an image file is allowed as a file input parameter for the prompt query.

  • Field Details

    • ATTR_SINGLE_IMAGE_INPUT

      static final String ATTR_SINGLE_IMAGE_INPUT
      The name of the single image input 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

    • getSingleImageInput

      SingularFileMode getSingleImageInput()
      Gets whether an image file is allowed as a file input parameter for the prompt query.
      Returns:
      Whether a single image input is allowed.

    • setSingleImageInput

      void setSingleImageInput(SingularFileMode singleImageInput)
      Sets whether an image file is allowed as a file input parameter for the prompt query.
      Parameters:
      singleImageInput - Whether a single image input is allowed.