pspdfkit/com.pspdfkit.annotations.measurements/MeasurementValueConfigurationEditor

MeasurementValueConfigurationEditor

interface MeasurementValueConfigurationEditor

Interface that allows you to modify the list of MeasurementValueConfigurations stored in the document. You can obtain an instance of it by calling getMeasurementValueConfigurationEditor

Types

Link copied to clipboard
interface ChangeListener
Listener interface to observe changes in the document's MeasurementValueConfiguration list

Functions

Link copied to clipboard
abstract fun add(@NonNull value: MeasurementValueConfiguration, addToUndo: Boolean)
Adds the `value` configuration to the document's configuration list.
abstract fun add(@NonNull context: Context, @NonNull value: MeasurementValueConfiguration, @NonNull onSelectedExistingConfiguration: MeasurementValueConfigurationPickerListener): Boolean
Adds the provided configuration to the document.
Link copied to clipboard
abstract fun addChangeListener(@NonNull listener: MeasurementValueConfigurationEditor.ChangeListener)
Register a ChangeListener to get notified when the document's MeasurementValueConfiguration list get's updated.
Link copied to clipboard
abstract fun getAnnotationsForConfiguration(@Nullable configuration: MeasurementValueConfiguration): List<Annotation>
Similar as getUsageCount but returns a list of all annotations that
Link copied to clipboard
@NonNull
abstract fun getConfigurations(): List<MeasurementValueConfiguration>
Query all MeasurementValueConfigurations currently existing in the document.
Link copied to clipboard
abstract fun getUsageCount(configuration: MeasurementValueConfiguration): Int
Checks how many annotations are using the provided configuration.
Link copied to clipboard
abstract fun modify(@NonNull context: Context, @NonNull oldValue: MeasurementValueConfiguration, @NonNull newValue: MeasurementValueConfiguration, @NonNull onSelectedExistingConfiguration: MeasurementValueConfigurationPickerListener): Boolean
Modifies an existing MeasurementValueConfiguration in the current document.
abstract fun modify(@NonNull oldValue: MeasurementValueConfiguration, @NonNull newValue: MeasurementValueConfiguration, modifyAssociatedAnnotations: Boolean, addToUndo: Boolean)
Replaces the `oldValue` configuration straightforward in the document's configuration list with `newValue`.
Link copied to clipboard
abstract fun remove(@NonNull context: Context, @NonNull value: MeasurementValueConfiguration): Boolean
Deletes the provided configuration from the document.
abstract fun remove(@NonNull value: MeasurementValueConfiguration, deleteAssociatedAnnotations: Boolean, addToUndo: Boolean)
Deletes the `value` configuration from the document's configuration list.
Link copied to clipboard
abstract fun removeChangeListener(@NonNull listener: MeasurementValueConfigurationEditor.ChangeListener)
Remove a previously registered ChangeListener.
Link copied to clipboard
abstract fun startCalibrationTool()
Starts the scale calibration tool.