nutrient/com.pspdfkit.ui.special_mode.controller/AnnotationToolVariant

AnnotationToolVariant

class AnnotationToolVariant : Parcelable

Annotation tools can have variants represented by the name. To create a custom annotation tool variant use fromName, and to get an instance of the default tool variant used by the framework, use defaultVariant static creator. This class represents a variant of the tool. You can pass it alongside the AnnotationTool in enterAnnotationCreationMode to start the annotation creation mode with the specified variant of the provided annotation tool.

Types

Annotation tool variants defined by the framework.

Properties

val CREATOR: Parcelable.Creator<AnnotationToolVariant>

Creator for Parcelable implementation that generates instances of AnnotationToolVariant from a Parcel.

val name: String

Name of the annotation tool variant, null by default.

Functions

open fun defaultVariant(): AnnotationToolVariant

Gets an instance of the default annotation tool variant used in the framework.

describeContents

open fun describeContents(): Int

Describes the kinds of special objects contained in this Parcelable instance's marshaled representation.

open fun equals(@Nullable obj: Any): Boolean

Compares this annotation tool variant to another object for equality.

open fun fromName(@NonNull variantName: String): AnnotationToolVariant

Gets an instance of the annotation tool variant with specified name.

open fun fromPreset(@NonNull preset: AnnotationToolVariant.Preset): AnnotationToolVariant

Gets an instance of the tool variant from the specified framework presets (the variants that are inside the framework by default)

open fun hashCode(): Int

Returns a hash code value for this annotation tool variant.

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

Writes this annotation tool variant to a Parcel.