public class

MarkupAnnotationDefaultsProvider

extends Object
implements AnnotationDefaultsAlphaProvider AnnotationDefaultsColorProvider
java.lang.Object
   ↳ com.pspdfkit.annotations.defaults.MarkupAnnotationDefaultsProvider

Class Overview

Defaults provider for markup annotations.

Summary

Public Constructors
MarkupAnnotationDefaultsProvider(Context context, AnnotationType annotationType)
MarkupAnnotationDefaultsProvider(Context context, AnnotationTool annotationTool)
Public Methods
boolean forceDefaults()

Enforce provided annotation defaults.

int[] getAvailableColors()
Provides colors available in the color picker.
float getDefaultAlpha()
Provides default annotation alpha.
int getDefaultColor()
Provides default annotation foreground color.
float getMaxAlpha()
Provides maximal annotation alpha.
float getMinAlpha()
Provides minimal annotation alpha.
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.AnnotationDefaultsAlphaProvider
From interface com.pspdfkit.annotations.defaults.AnnotationDefaultsColorProvider
From interface com.pspdfkit.annotations.defaults.AnnotationDefaultsProvider

Public Constructors

public MarkupAnnotationDefaultsProvider (Context context, AnnotationType annotationType)

public MarkupAnnotationDefaultsProvider (Context context, AnnotationTool annotationTool)

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 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 getMaxAlpha ()

Provides maximal annotation alpha.

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

public float getMinAlpha ()

Provides minimal annotation alpha.

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

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.