Package com.polarion.alm.tracker.exporter.configuration

Class PageWatermark

java.lang.Object
com.polarion.alm.tracker.exporter.configuration.PageWatermark
public class PageWatermark extends Object
Specify a watermark for an exporter. A watermark image is stored in the repository or provided as a stream (see PageWatermark.Builder.withImageContent(Supplier)). The Watermark's name MUST start with the folder name they are stored in. For example, confidential_portrait_A4.png must be in the .polarion/wiki/watermarks/confidential folder. (Relative to the project or repository root.) The file name can contain additional parameters separated by an "_" that define the orientation and paper size. (Based on the ids of the respective enumeration options.) Examples of file names for a watermark with a "confidential" id, found in the "confidential" folder, could include: confidential.png confidential_portrait.png confidential_portrait_A4.png
Since:
3.17.1

  • Method Details

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • id

      @Nullable public String id()

    • opacity

      @Nullable public Integer opacity()

    • imageContent

      @Nullable public Supplier<InputStream> imageContent()
      Gets the content of the image to be used as the watermark. If null is returned, the image will be searched for in the repository by id.
      See Also:

    • create

      @NotNull public static PageWatermark.Builder create()
      Creates an empty builder.

    • createCopy

      @NotNull public PageWatermark.Builder createCopy()
      Creates a builder with the prefilled values from the current instance.