public interface

AnnotationDefaultsManager

com.pspdfkit.annotations.defaults.AnnotationDefaultsManager

Class Overview

Interface for objects that manage a list of AnnotationDefaultsProvider for supported annotation types.

Summary

Public Methods
abstract AnnotationDefaultsProvider getAnnotationDefaultsProvider(AnnotationTool annotationTool)
Retrieve annotation defaults provider for given annotation tool.
abstract <T extends AnnotationDefaultsProvider> T getAnnotationDefaultsProvider(AnnotationType annotationType, Class<T> requiredClass)
Retrieve annotation defaults provider for given annotation type casted to required provider type.
abstract AnnotationDefaultsProvider getAnnotationDefaultsProvider(AnnotationType annotationType)
Retrieve annotation defaults provider for given annotation type.
abstract <T extends AnnotationDefaultsProvider> T getAnnotationDefaultsProvider(AnnotationTool annotationTool, Class<T> requiredClass)
Retrieve annotation defaults provider for given annotation tool casted to required provider type.
abstract void setAnnotationDefaultsProvider(AnnotationType annotationType, AnnotationDefaultsProvider provider)
Registers annotation defaults provider for given annotation type.
abstract void setAnnotationDefaultsProvider(AnnotationTool annotationTool, AnnotationDefaultsProvider provider)
Registers annotation defaults provider for given annotation tool.
abstract boolean supportsAnnotationProperty(AnnotationTool annotationTool, AnnotationProperty property)
Tests if annotation tool supports editing given property.
abstract boolean supportsAnnotationProperty(AnnotationType annotationType, AnnotationProperty property)
Tests if annotation type supports editing given property.

Public Methods

public abstract AnnotationDefaultsProvider getAnnotationDefaultsProvider (AnnotationTool annotationTool)

Retrieve annotation defaults provider for given annotation tool. If no annotation provider is set for annotation tool, annotation provider for underlying annotation type (toAnnotationType() is returned.

Parameters
annotationTool Annotation tool for which to retrieve defaults provider.
Returns
  • Annotation default provider or null if provider does not exist.

public abstract T getAnnotationDefaultsProvider (AnnotationType annotationType, Class<T> requiredClass)

Retrieve annotation defaults provider for given annotation type casted to required provider type.

Parameters
annotationType Type of annotation for which to retrieve defaults provider.
requiredClass Required type of annotation defaults provider.
Returns
  • Annotation default provider casted to requiredClass or null if provider does not exist or has other type than T.

public abstract AnnotationDefaultsProvider getAnnotationDefaultsProvider (AnnotationType annotationType)

Retrieve annotation defaults provider for given annotation type.

Parameters
annotationType Type of annotation for which to retrieve defaults provider.
Returns
  • Annotation default provider or null if provider does not exist.

public abstract T getAnnotationDefaultsProvider (AnnotationTool annotationTool, Class<T> requiredClass)

Retrieve annotation defaults provider for given annotation tool casted to required provider type. If no annotation provider is set for annotation tool, annotation provider for underlying annotation type (toAnnotationType() is returned.

Parameters
annotationTool Annotation tool for which to retrieve defaults provider.
requiredClass Required type of annotation defaults provider.
Returns
  • Annotation default provider casted to requiredClass or null if provider does not exist or has other type than T.

public abstract void setAnnotationDefaultsProvider (AnnotationType annotationType, AnnotationDefaultsProvider provider)

Registers annotation defaults provider for given annotation type. This replaces default provider.

Parameters
annotationType Type of annotation for which to register defaults provider.
provider Provider to register.

public abstract void setAnnotationDefaultsProvider (AnnotationTool annotationTool, AnnotationDefaultsProvider provider)

Registers annotation defaults provider for given annotation tool. This replaces default provider.

Parameters
annotationTool Annotation tool for which to register defaults provider.
provider Provider to register.

public abstract boolean supportsAnnotationProperty (AnnotationTool annotationTool, AnnotationProperty property)

Tests if annotation tool supports editing given property.

public abstract boolean supportsAnnotationProperty (AnnotationType annotationType, AnnotationProperty property)

Tests if annotation type supports editing given property.