Package net.webpdf.wsclient.openapi

Class OperationRedactAnnotation

  • public class OperationRedactAnnotation
extends Object
    An annotation that marks page content for redaction.

    • Constructor Detail

      • OperationRedactAnnotation

        public OperationRedactAnnotation()

    • Method Detail

      • getColor

        @Nullable
public @Nullable String getColor()
        The annotation color will change the main color of visible annotations. The color needs to be specified as a hexadecimal RGB value with a number sign before it.
        Returns:
        color

      • setColor

        public void setColor​(String color)

      • getContents

        @Nullable
public @Nullable String getContents()
        This value is used to configure the text content of the annotation, with the way in which it is displayed depending heavily on the specific annotation type (for example, in the case of a text note, this would be the text content of the annotation's popup).
        Returns:
        contents

      • setContents

        public void setContents​(String contents)

      • getCreator

        @Nullable
public @Nullable String getCreator()
        Used to specify the author of the annotation.
        Returns:
        creator

      • setCreator

        public void setCreator​(String creator)

      • getHidden

        @Nullable
public @Nullable Boolean getHidden()
        If this value is set to true, the annotation will not be shown on the page and will not be printed either.
        Returns:
        hidden

      • setHidden

        public void setHidden​(Boolean hidden)

      • getIntents

        @Nullable
public @Nullable String getIntents()
        Used to set the intention of the annotation. **Important:** The intention of an annotation can directly influence it's behaviour and may serve different purposes for different annotation types. Only set this directly, if you know it is necessary and possible to do so.
        Returns:
        intents

      • setIntents

        public void setIntents​(String intents)

      • getInteriorColor

        @Nullable
public @Nullable String getInteriorColor()
        The annotation color will change the interior color of visible annotations. The color needs to be specified as a hexadecimal RGB value with a number sign before it.
        Returns:
        interiorColor

      • setInteriorColor

        public void setInteriorColor​(String interiorColor)

      • getInvisible

        @Nullable
public @Nullable Boolean getInvisible()
        If this value is set to true, the annotation will be visible on the page only when printed, and provided it is a PDF standard annotation.
        Returns:
        invisible

      • setInvisible

        public void setInvisible​(Boolean invisible)

      • getLocked

        @Nullable
public @Nullable Boolean getLocked()
        If this value is set to true, the annotation will be locked so that no changes can be made to it.
        Returns:
        locked

      • setLocked

        public void setLocked​(Boolean locked)

      • getName

        @Nullable
public @Nullable String getName()
        Used to specify the name of the annotation.
        Returns:
        name

      • setName

        public void setName​(String name)

      • getOpacity

        @Nullable
public @Nullable Integer getOpacity()
        This percentage value is used to set the annotation's transparency. minimum: 0 maximum: 100
        Returns:
        opacity

      • setOpacity

        public void setOpacity​(Integer opacity)

      • getPage

        @Nullable
public @Nullable Integer getPage()
        Set the number of the page, the annotation shall be placed on. minimum: 1
        Returns:
        page

      • setPage

        public void setPage​(Integer page)

      • getPrintable

        @Nullable
public @Nullable Boolean getPrintable()
        If this value is set to true, the annotation will be included when the page is printed out.
        Returns:
        printable

      • setPrintable

        public void setPrintable​(Boolean printable)

      • getRotatable

        @Nullable
public @Nullable Boolean getRotatable()
        If this value is set to true, the annotation shall be rotatable according to the displayed page rotation.
        Returns:
        rotatable

      • setRotatable

        public void setRotatable​(Boolean rotatable)

      • getSubject

        @Nullable
public @Nullable String getSubject()
        Used to specify the subject of the annotation.
        Returns:
        subject

      • setSubject

        public void setSubject​(String subject)

      • getViewable

        @Nullable
public @Nullable Boolean getViewable()
        If this value is set to true, the annotation will be shown on the document's page.
        Returns:
        viewable

      • setViewable

        public void setViewable​(Boolean viewable)

      • getWritable

        @Nullable
public @Nullable Boolean getWritable()
        If this value is set to true, it will be possible to change the annotation's contents later on.
        Returns:
        writable

      • setWritable

        public void setWritable​(Boolean writable)

      • getZoomable

        @Nullable
public @Nullable Boolean getZoomable()
        If this value is set to true, the annotation will adjust its own zoom factor as required for the page in order to always be clearly readable / recognizable.
        Returns:
        zoomable

      • setZoomable

        public void setZoomable​(Boolean zoomable)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object