nutrient/com.pspdfkit.annotations.stamps/StampType

StampType

The type of stamp a StampAnnotation has. The type influences how the the annotation is rendered and how other PDF applications handle editing it.

Constructors

StampType

constructor(@NonNull name: String)

Creates a StampType for the given name.

Properties

ACCEPTED

val ACCEPTED: StampType

Rendered as a Tick.

APPROVED

val APPROVED: StampType

Standard "Approved" stamp type as defined in the PDF specification.

AS_IS

val AS_IS: StampType

Standard "As Is" stamp type as defined in the PDF specification.

COMPLETED

val COMPLETED: StampType

"Completed" stamp type supported by Adobe Acrobat.

CONFIDENTIAL

val CONFIDENTIAL: StampType

Standard "Confidential" stamp type as defined in the PDF specification.

CREATOR

val CREATOR: Parcelable.Creator<StampType>

Parcelable CREATOR for deserializing StampType instances from a Parcel.

DEPARTMENTAL

val DEPARTMENTAL: StampType

Standard "Departmental" stamp type as defined in the PDF specification.

DRAFT

val DRAFT: StampType

Standard "Draft" stamp type as defined in the PDF specification.

EXPERIMENTAL

val EXPERIMENTAL: StampType

Standard "Experimental" stamp type as defined in the PDF specification.

EXPIRED

val EXPIRED: StampType

Standard "Expired" stamp type as defined in the PDF specification.

FINAL

val FINAL: StampType

Standard "Final" stamp type as defined in the PDF specification.

FOR_COMMENT

val FOR_COMMENT: StampType

Standard "For Comment" stamp type as defined in the PDF specification.

FOR_PUBLIC_RELEASE

val FOR_PUBLIC_RELEASE: StampType

Standard "For Public Release" stamp type as defined in the PDF specification.

INFORMATION_ONLY

val INFORMATION_ONLY: StampType

"Information Only" stamp type supported by Adobe Acrobat.

INITIAL_HERE

val INITIAL_HERE: StampType

"Initial Here" signature stamp type for marking where initials should be placed.

name

@get:NonNull

open val name: String

The name of this stamp type.

NOT_APPROVED

val NOT_APPROVED: StampType

Standard "Not Approved" stamp type as defined in the PDF specification.

NOT_FOR_PUBLIC_RELEASE

val NOT_FOR_PUBLIC_RELEASE: StampType

Standard "Not For Public Release" stamp type as defined in the PDF specification.

PRELIMINARY_RESULTS

val PRELIMINARY_RESULTS: StampType

"Preliminary Results" stamp type supported by Adobe Acrobat.

REJECTED

val REJECTED: StampType

Rendered as a Cross.

REVISED

val REVISED: StampType

"Revised" stamp type supported by Adobe Acrobat.

SIGN_HERE

val SIGN_HERE: StampType

"Sign Here" signature stamp type for marking where signatures should be placed.

SOLD

val SOLD: StampType

Standard "Sold" stamp type as defined in the PDF specification.

TOP_SECRET

val TOP_SECRET: StampType

Standard "Top Secret" stamp type as defined in the PDF specification.

VOID

val VOID: StampType

"Void" stamp type supported by Adobe Acrobat.

WITNESS

val WITNESS: StampType

"Witness" signature stamp type for marking witness signature locations.

Functions

describeContents

open fun describeContents(): Int

Describes the kinds of special objects contained in this Parcelable instance.

equals

open fun equals(o: Any): Boolean

Compares this stamp type to another object for equality based on the stamp name.

hashCode

open fun hashCode(): Int

Returns a hash code value for this stamp type based on its name.

isStandard

open fun isStandard(): Boolean

Checks whether this is a standard stamp type known to PSPDFKit, in which case the title and subtitle are supplied automatically based on the type.

toString

open fun toString(): String

Returns a string representation of this stamp type.

writeToParcel

open fun writeToParcel(parcel: Parcel, i: Int)

Flattens this stamp type into a Parcel.