Package com.pspdfkit.annotations.configuration

Interface AnnotationConfiguration.Builder

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract T setSupportedProperties(@NonNull() 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.
      abstract T disableProperty(@NonNull() 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 AnnotationConfiguration build() Builds the annotation configuration from values configured by this builder.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • setSupportedProperties

        @NonNull() abstract T setSupportedProperties(@NonNull() 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.

      • setZIndexEditingEnabled

         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.

      • disableProperty

        @NonNull() abstract T disableProperty(@NonNull() 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.

      • setForceDefaults

        @NonNull() 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.