public static interface

AnnotationConfiguration.Builder

com.pspdfkit.annotations.configuration.AnnotationConfiguration.Builder<T>
Known Indirect Subclasses

Class Overview

Builder for AnnotationConfiguration. All builders declared in subclasses of annotation configuration must extend this builder.

Summary

Public Methods
abstract AnnotationConfiguration build()
Builds the annotation configuration from values configured by this builder.
abstract T disableProperty(AnnotationProperty disabledProperty)
Removes specific property from the supported properties.
abstract T setForceDefaults(boolean forceDefaults)
Sets whether annotation defaults defined in the configuration should be enforced.
abstract T setSupportedProperties(EnumSet<AnnotationProperty> supportedProperties)
Controls which annotation properties are enabled for specific annotation type or tool.
abstract T setZIndexEditingEnabled(boolean enabled)
Sets whether the z-index editing is enabled for specific annotation type or tool.

Public Methods

public abstract AnnotationConfiguration build ()

Builds the annotation configuration from values configured by this builder.

public abstract T disableProperty (AnnotationProperty disabledProperty)

Removes specific property from the supported properties. This disables annotation inspector for this property.

Parameters
disabledProperty Property that should be removed from supported properties.

public abstract T setForceDefaults (boolean forceDefaults)

Sets whether annotation defaults defined in the configuration should be enforced.

By default last picked values are used when creating annotations. Configured defaults are are used only when last used value is not available.

Parameters
forceDefaults true to always use annotation defaults.

public abstract T setSupportedProperties (EnumSet<AnnotationProperty> supportedProperties)

Controls which annotation properties are enabled for specific annotation type or tool. This is used to customize annotation inspector contents. Defaults to all properties supported by annotation type/tool.

Parameters
supportedProperties Enum set of all supported annotation properties.

public abstract T setZIndexEditingEnabled (boolean enabled)

Sets whether the z-index editing is enabled for specific annotation type or tool.

Parameters
enabled true to enable z-index editing, false to disable it.