java.lang.Object
   ↳ com.pspdfkit.annotations.defaults.InkAnnotationDefaultsProvider
Known Direct Subclasses
Known Indirect Subclasses

This class is deprecated.
Use InkAnnotationConfiguration.Builder instead.

Class Overview

Defaults provider for ink annotations.

Summary

Fields
protected final Context context
Public Constructors
InkAnnotationDefaultsProvider(Context context)
Public Methods
boolean forceDefaults()

Enforce provided annotation defaults.

AnnotationAggregationStrategy getAggregationStrategy()
Returns AnnotationAggregationStrategy that should be used for this annotation type.
int[] getAvailableColors()
Provides colors available in the color picker.
float getDefaultAlpha()
Provides default annotation alpha.
int getDefaultColor()
Provides default annotation foreground color.
float getDefaultThickness()
Provides default annotation thickness.
float getMaxAlpha()
Provides maximal annotation alpha.
float getMaxThickness()
Provides maximal annotation thickness.
float getMinAlpha()
Provides minimal annotation alpha.
float getMinThickness()
Provides minimal annotation thickness.
EnumSet<AnnotationProperty> getSupportedProperties()
Control which annotation properties are enabled for this annotation type.
boolean isPreviewEnabled()
Controls whether annotation preview is enabled when creating annotations.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.pspdfkit.annotations.defaults.AnnotationAggregationStrategyDefaultsProvider
From interface com.pspdfkit.annotations.defaults.AnnotationDefaultsAlphaProvider
From interface com.pspdfkit.annotations.defaults.AnnotationDefaultsColorProvider
From interface com.pspdfkit.annotations.defaults.AnnotationDefaultsPreviewProvider
From interface com.pspdfkit.annotations.defaults.AnnotationDefaultsProvider
From interface com.pspdfkit.annotations.defaults.AnnotationDefaultsThicknessProvider

Fields

protected final Context context

Public Constructors

public InkAnnotationDefaultsProvider (Context context)

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 AnnotationAggregationStrategy getAggregationStrategy ()

Returns AnnotationAggregationStrategy that should be used for this annotation type.

public int[] getAvailableColors ()

Provides colors available in the color picker.

public float getDefaultAlpha ()

Provides default annotation alpha.

Returns
  • The default annotation alpha in percent from 0 to 1.

public int getDefaultColor ()

Provides default annotation foreground color.

Returns
  • Foreground color used as default for editing annotations.

public float getDefaultThickness ()

Provides default annotation thickness.

Returns
  • The default annotation thickness in pt.

public float getMaxAlpha ()

Provides maximal annotation alpha.

Returns
  • The maximal annotation alpha in percent from 0 to 1.

public float getMaxThickness ()

Provides maximal annotation thickness.

Returns
  • The maximal annotation thickness in pt.

public float getMinAlpha ()

Provides minimal annotation alpha.

Returns
  • The minimal annotation alpha in percent from 0 to 1.

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.

public boolean isPreviewEnabled ()

Controls whether annotation preview is enabled when creating annotations.