Package net.webpdf.wsclient.openapi

Class OperationRubberStampAnnotation

  • public class OperationRubberStampAnnotation
extends Object
    An annotation that either uses an custom image or text as a stamp, or that adds a prepared \"named\" stamp to the page.

    • Constructor Detail

      • OperationRubberStampAnnotation

        public OperationRubberStampAnnotation()

    • Method Detail

      • getAppearanceGeneration

        @Nullable
public @Nullable OperationRubberStampAnnotation.AppearanceGenerationEnum getAppearanceGeneration()
        Determines for which named annotations appearance streams shall be generated. **Important:** Per definition some named annotations are defined as standard names and PDF readers shall provide the means to draw those. * always = An appearance stream shall be prepared for all created named annotations. * never = Don't provide appearance streams and rely on PDF readers to dynamically generate a proper representation of named annotations. * nonStandard = Only provide appearance streams for non-standard annotations.
        Returns:
        appearanceGeneration

      • 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)

      • getCustomIconName

        @Nullable
public @Nullable String getCustomIconName()
        Sets a custom icon name for this annotation. **Important:** This name shall always take precedence over possibly set standard names. (icon)
        Returns:
        customIconName

      • setCustomIconName

        public void setCustomIconName​(String customIconName)

      • 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)

      • getIcon

        @Nullable
public @Nullable OperationRubberStampAnnotation.IconEnum getIcon()
        The known \"named\" icon types for rubberstamp annotations: * approved = A stamp that marks the stamped context as approved. * experimental = A stamp that marks the stamped content to be an experimental state. * notApproved = A stamp that disapproves the stamped context. * asIs = A stamp that marks the content as is. * expired = A stamp that marks the contained information as no longer valid. * notForPublicRelease = A stamp that marks something as information for internal use only. * confidential = A stamp marking the page as confidential. * final = A stamp that indicates, that the current state of the document is final. * sold = A stamp that indicates the marked contents to be sold and no longer available. * departmental = A stamp that forbids information to be shared to recipient outside of a given department. * forComment = Marks the stamped context as a comment. * topSecret = Marks the stamped content not to be shared publicly. * draft = A stamp marking the content to be a draft and therefore a work in progress. * forPublicRelease = Marks the content for public sharing. * unnamed = The rubberstamp shall not provide a predefined name.
        Returns:
        icon

      • 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)

      • 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)

      • getNormalAppearance

        @Nullable
public @Nullable OperationAppearanceSource getNormalAppearance()
        Get normalAppearance
        Returns:
        normalAppearance

      • 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