public class

EraserDefaultsProvider

extends Object
implements AnnotationDefaultsThicknessProvider
java.lang.Object
   ↳ com.pspdfkit.annotations.defaults.EraserDefaultsProvider

Class Overview

Defaults provider for eraser tool.

Summary

Public Constructors
EraserDefaultsProvider()
Public Methods
boolean forceDefaults()

Enforce provided annotation defaults.

float getDefaultThickness()
Provides default annotation thickness.
float getMaxThickness()
Provides maximal annotation thickness.
float getMinThickness()
Provides minimal annotation thickness.
EnumSet<AnnotationProperty> getSupportedProperties()
Control which annotation properties are enabled for this annotation type.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.pspdfkit.annotations.defaults.AnnotationDefaultsProvider
From interface com.pspdfkit.annotations.defaults.AnnotationDefaultsThicknessProvider

Public Constructors

public EraserDefaultsProvider ()

Public Methods

public boolean forceDefaults ()

Enforce provided annotation defaults. By default last picked values are used when creating annotations. Values from AnnotationDefaultsProvider are used only when last used value is not available.

For example getDefaultColor() is used only when creating annotation of given type for the first time, all annotation created after that are created with last used color.

Returns

public float getDefaultThickness ()

Provides default annotation thickness.

Returns
  • The default annotation thickness in pt.

public float getMaxThickness ()

Provides maximal annotation thickness.

Returns
  • The maximal annotation thickness in pt.

public float getMinThickness ()

Provides minimal annotation thickness.

Returns
  • The minimal annotation thickness in pt.

public EnumSet<AnnotationProperty> getSupportedProperties ()

Control which annotation properties are enabled for this annotation type. This is used to customize annotation inspector contents. Property can be editable in annotation inspector when its returned by this method and annotation defaults provider implements required interface. For example to enable editing annotation color property, this method must return COLOR and annotation defaults provider must implement AnnotationDefaultsColorProvider.

Returns
  • Enum set of all supported annotation properties.