Interface IPromptQueryConfig_AddWatermark

public interface IPromptQueryConfig_AddWatermark
Mixin for a query connection configuration model that allows the user to configure whether a watermark should be added to generated files (such as images). A watermark may serve various purposes, such as indicating the source of the generated content or asserting copyright.

See also the <xp:addWatermark/> 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_ADD_WATERMARK
    The name of the add watermark attribute.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isAddWatermark()
    Gets whether a watermark should be added to generated files.
    void
    setAddWatermark(boolean addWatermark)
    Sets whether a watermark should be added to generated files.

  • Field Details

    • ATTR_ADD_WATERMARK

      static final String ATTR_ADD_WATERMARK
      The name of the add watermark 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

    • isAddWatermark

      boolean isAddWatermark()
      Gets whether a watermark should be added to generated files. If true, the prompt service may add a watermark. If false, it should not add a watermark.
      Returns:
      Whether a watermark should be added.

    • setAddWatermark

      void setAddWatermark(boolean addWatermark)
      Sets whether a watermark should be added to generated files. If true, the prompt service may add a watermark. If false, it should not add a watermark.
      Parameters:
      addWatermark - Whether to add a watermark.