public final enum

AnnotationTool

extends Enum<E extends Enum<E>>
java.lang.Object
   ↳ java.lang.Enum<E extends java.lang.Enum<E>>
     ↳ com.pspdfkit.ui.special_mode.controller.AnnotationTool

Class Overview

All currently supported tools when creating annotations.

Summary

Enum Values
AnnotationTool  CAMERA  Creates stamp annotation from camera image. 
AnnotationTool  CIRCLE  Creates circle annotations. 
AnnotationTool  ERASER  Ink eraser. 
AnnotationTool  FREETEXT  Creates free-text annotations. 
AnnotationTool  FREETEXT_CALLOUT  Creates free-text callout annotations. 
AnnotationTool  HIGHLIGHT  Creates highlight text markup annotations. 
AnnotationTool  IMAGE  Creates stamp annotation from user supplied bitmaps. 
AnnotationTool  INK  Creates ink annotations. 
AnnotationTool  INSTANT_COMMENT_MARKER  A freely placeable Instant Comments thread. 
AnnotationTool  INSTANT_HIGHLIGHT_COMMENT  A text highlight that acts as the root for an Instant Comments thread. 
AnnotationTool  LINE  Creates line annotations. 
AnnotationTool  MAGIC_INK  Magic ink tool. 
AnnotationTool  MEASUREMENT_AREA_ELLIPSE  Creates an elliptical area measurement annotation. 
AnnotationTool  MEASUREMENT_AREA_POLYGON  Creates a polygonal area measurement annotation. 
AnnotationTool  MEASUREMENT_AREA_RECT  Creates a rectangular area measurement annotation. 
AnnotationTool  MEASUREMENT_DISTANCE  Creates a distance measurement annotation. 
AnnotationTool  MEASUREMENT_PERIMETER  Creates a perimeter measurement annotation. 
AnnotationTool  NONE  Indicates that no annotation tool is selected. 
AnnotationTool  NOTE  Creates note annotations. 
AnnotationTool  POLYGON  Creates polygon annotations. 
AnnotationTool  POLYLINE  Creates polyline annotations. 
AnnotationTool  REDACTION  Annotation redaction. 
AnnotationTool  SIGNATURE  Creates ink annotation from user/customer signature. 
AnnotationTool  SOUND  Creates sound annotations. 
AnnotationTool  SQUARE  Creates square annotations. 
AnnotationTool  SQUIGGLY  Creates squiggly text markup annotations. 
AnnotationTool  STAMP  Creates stamp annotations from pre-built stamps. 
AnnotationTool  STRIKEOUT  Creates strikeout text markup annotations. 
AnnotationTool  UNDERLINE  Creates underline text markup annotations. 
Public Methods
static AnnotationTool fromAnnotationType(AnnotationType annotationType)
Convert AnnotationType to AnnotationTool.
AnnotationType toAnnotationType()
Convert to AnnotationType which creation is handled by this tool.
static AnnotationTool valueOf(String name)
final static AnnotationTool[] values()
[Expand]
Inherited Methods
From class java.lang.Enum
From class java.lang.Object
From interface java.lang.Comparable

Enum Values

public static final AnnotationTool CAMERA

Creates stamp annotation from camera image.

public static final AnnotationTool CIRCLE

Creates circle annotations.

public static final AnnotationTool ERASER

Ink eraser.

public static final AnnotationTool FREETEXT

Creates free-text annotations.

public static final AnnotationTool FREETEXT_CALLOUT

Creates free-text callout annotations.

public static final AnnotationTool HIGHLIGHT

Creates highlight text markup annotations.

public static final AnnotationTool IMAGE

Creates stamp annotation from user supplied bitmaps.

public static final AnnotationTool INK

Creates ink annotations.

public static final AnnotationTool INSTANT_COMMENT_MARKER

A freely placeable Instant Comments thread.

public static final AnnotationTool INSTANT_HIGHLIGHT_COMMENT

A text highlight that acts as the root for an Instant Comments thread.

public static final AnnotationTool LINE

Creates line annotations.

public static final AnnotationTool MAGIC_INK

Magic ink tool. Creates ink annotations or similar shape annotations (line, square, circle).

public static final AnnotationTool MEASUREMENT_AREA_ELLIPSE

Creates an elliptical area measurement annotation.

public static final AnnotationTool MEASUREMENT_AREA_POLYGON

Creates a polygonal area measurement annotation.

public static final AnnotationTool MEASUREMENT_AREA_RECT

Creates a rectangular area measurement annotation.

public static final AnnotationTool MEASUREMENT_DISTANCE

Creates a distance measurement annotation.

public static final AnnotationTool MEASUREMENT_PERIMETER

Creates a perimeter measurement annotation.

public static final AnnotationTool NONE

Indicates that no annotation tool is selected.

public static final AnnotationTool NOTE

Creates note annotations.

public static final AnnotationTool POLYGON

Creates polygon annotations.

public static final AnnotationTool POLYLINE

Creates polyline annotations.

public static final AnnotationTool REDACTION

Annotation redaction.

public static final AnnotationTool SIGNATURE

Creates ink annotation from user/customer signature.

public static final AnnotationTool SOUND

Creates sound annotations.

public static final AnnotationTool SQUARE

Creates square annotations.

public static final AnnotationTool SQUIGGLY

Creates squiggly text markup annotations.

public static final AnnotationTool STAMP

Creates stamp annotations from pre-built stamps.

public static final AnnotationTool STRIKEOUT

Creates strikeout text markup annotations.

public static final AnnotationTool UNDERLINE

Creates underline text markup annotations.

Public Methods

public static AnnotationTool fromAnnotationType (AnnotationType annotationType)

Convert AnnotationType to AnnotationTool.

Returns
  • AnnotationTool that creates annotationType, or NONE if not supported.

public AnnotationType toAnnotationType ()

Convert to AnnotationType which creation is handled by this tool.

public static AnnotationTool valueOf (String name)

public static final AnnotationTool[] values ()