pspdfkit/com.pspdfkit.annotations.stamps/StampPickerItem

StampPickerItem

open class StampPickerItem : Parcelable

Entity representing single stamp in StampPickerDialog.

Types

BitmapStampBuilder

open class BitmapStampBuilder

Builder for creating custom stamps with bitmap image.

Builder

open class Builder

Builder for creating custom stamps from PredefinedStampType or custom String stamp type.

Properties

appearanceStreamGenerator

@Nullable

@get:Nullable

val appearanceStreamGenerator: AppearanceStreamGenerator

bitmap

@Nullable

@get:Nullable

val bitmap: Bitmap

CREATOR

val CREATOR: Parcelable.Creator<StampPickerItem>

A field that generates the instances of this class from the provided Parcel.

DEFAULT_STAMP_ANNOTATION_ASPECT_RATIO

val DEFAULT_STAMP_ANNOTATION_ASPECT_RATIO: Float = 0.33333334f

Default stamp annotation aspect ration.

DEFAULT_STAMP_ANNOTATION_PDF_HEIGHT

val DEFAULT_STAMP_ANNOTATION_PDF_HEIGHT: Float = 70.0f

Default stamp annotation height.

DEFAULT_STAMP_ANNOTATION_PDF_WIDTH

val DEFAULT_STAMP_ANNOTATION_PDF_WIDTH: Float = 210.0f

Default stamp annotation width.

defaultPdfHeight

@get:FloatRange(from = 0.0)

val defaultPdfHeight: Float

defaultPdfWidth

@get:FloatRange(from = 0.0)

val defaultPdfWidth: Float

stampType

@Nullable

@get:Nullable

val stampType: StampType

subtitle

@Nullable

@get:Nullable

val subtitle: String

textColor

@Nullable

@ColorInt

@get:Nullable

val textColor: Integer

title

@Nullable

@get:Nullable

val title: String

Functions

createStampAnnotation

@NonNull

open fun createStampAnnotation(@IntRange(from = 0) pageIndex: Int): StampAnnotation

Creates stamp annotation from picker item data.

describeContents

open fun describeContents(): Int

fromBitmap

@NonNull

open fun fromBitmap(@NonNull bitmap: Bitmap): StampPickerItem.BitmapStampBuilder

Creates builder for stamp annotation with bitmap image.

fromPredefinedType

open fun fromPredefinedType(@NonNull context: Context, @NonNull predefinedStampType: PredefinedStampType): StampPickerItem.Builder

Creates builder for stamp annotations pre-filled with properties of .

fromStampType

open fun fromStampType(@NonNull context: Context, @NonNull stampType: StampType): StampPickerItem.Builder

Creates builder for stamp annotation using a custom stamp type.

fromTitle

open fun fromTitle(@NonNull context: Context, @NonNull title: String): StampPickerItem.Builder

Creates builder for stamp annotation using a title.

getDefaultStampPickerItems

@NonNull

open fun getDefaultStampPickerItems(@NonNull context: Context): List<StampPickerItem>

Returns default list of stamp picker items.

isCustomStamp

open fun isCustomStamp(): Boolean

Returns true for special custom stamp can be personalized by users.

mutate

@NonNull

open fun mutate(): StampPickerItem

Create new instance of this item.

renderAppearanceStreamToBitmapAsync

open fun renderAppearanceStreamToBitmapAsync(@NonNull context: Context): Single<Bitmap>

Renders configured appearance stream to bitmap with size defined in getDefaultPdfWidth and getDefaultPdfHeight scaled to display size.

writeToParcel

open fun writeToParcel(dest: Parcel, flags: Int)