Enum AnnotationTool
-
- All Implemented Interfaces:
public enum AnnotationTool
All currently supported tools when creating annotations.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description NONE
Indicates that no annotation tool is selected.
HIGHLIGHT
Creates highlight text markup annotations.
STRIKEOUT
Creates strikeout text markup annotations.
UNDERLINE
Creates underline text markup annotations.
SQUIGGLY
Creates squiggly text markup annotations.
FREETEXT
Creates free-text annotations.
FREETEXT_CALLOUT
Creates free-text callout annotations.
INK
Creates ink annotations.
MAGIC_INK
Magic ink tool. Creates ink annotations or similar shape annotations (line, square, circle).
SIGNATURE
Creates ink annotation from user/customer signature.
NOTE
Creates note annotations.
LINE
Creates line annotations.
SQUARE
Creates square annotations.
CIRCLE
Creates circle annotations.
POLYGON
Creates polygon annotations.
POLYLINE
Creates polyline annotations.
MEASUREMENT_DISTANCE
Creates a distance measurement annotation.
MEASUREMENT_PERIMETER
Creates a perimeter measurement annotation.
MEASUREMENT_AREA_POLYGON
Creates a polygonal area measurement annotation.
MEASUREMENT_AREA_ELLIPSE
Creates an elliptical area measurement annotation.
MEASUREMENT_AREA_RECT
Creates a rectangular area measurement annotation.
MEASUREMENT_SCALE_CALIBRATION
Creates a rectangular area measurement annotation.
STAMP
Creates stamp annotations from pre-built stamps.
IMAGE
Creates stamp annotation from user supplied bitmaps.
CAMERA
Creates stamp annotation from camera image.
SOUND
Creates sound annotations.
ERASER
Ink eraser.
REDACTION
Annotation redaction.
INSTANT_COMMENT_MARKER
A freely placeable Instant Comments thread.
INSTANT_HIGHLIGHT_COMMENT
A text highlight that acts as the root for an Instant Comments thread.
ANNOTATION_MULTI_SELECTION
Allows selection of multiple annotations
-
Method Summary
Modifier and Type Method Description static AnnotationTool
fromAnnotationType(@Nullable() AnnotationType annotationType)
Convert AnnotationType to AnnotationTool
.AnnotationType
toAnnotationType()
Convert to AnnotationType which creation is handled by this tool. static Array<AnnotationTool>
values()
Returns an array containing the constants of this enum type, in the order they're declared. static AnnotationTool
valueOf(String name)
Returns the enum constant of this type with the specified name. -
-
Method Detail
-
fromAnnotationType
@NonNull() static AnnotationTool fromAnnotationType(@Nullable() AnnotationType annotationType)
Convert AnnotationType to
AnnotationTool
.- Returns:
AnnotationTool
that createsannotationType
, or NONE if not supported.
-
toAnnotationType
@NonNull() AnnotationType toAnnotationType()
Convert to AnnotationType which creation is handled by this tool.
-
values
static Array<AnnotationTool> values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants.
- Returns:
an array containing the constants of this enum type, in the order they're declared
-
valueOf
static AnnotationTool valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
- Returns:
the enum constant with the specified name
-
-
-
-