nutrient/com.pspdfkit.ui.inspector.views/ScaleCalibrationPickerInspectorView

ScaleCalibrationPickerInspectorView

class ScaleCalibrationPickerInspectorView(lineAnnotation: LineAnnotation, context: Context, label: String, defaultUnit: Scale.UnitTo, focusValueText: Boolean, listener: ScaleCalibrationPickerInspectorView.CalibrationPickerListener?) : FrameLayout, PropertyInspectorView, PropertyInspectorTitleButtonListener

Inspector component for setting measurement scale via calibration picker. Calibration picker is added to the distance measurement tools as a way of setting scale by calibrating a distance annotation to the desired length and unit.

Parameters

lineAnnotation

the lineannotation whose length we calibrate

context

The context to use.

label

text describing the calibration value

defaultUnit

Default Scale.UnitTo value selected. This should always be the same as the Scale destination ("to") unit.

focusValueText

if true the value text widget will be focused and the keyboard be shown automatically after showing the inspector

listener

Listener for calibration picker changes.

Constructors

ScaleCalibrationPickerInspectorView

constructor(lineAnnotation: LineAnnotation, context: Context, label: String, defaultUnit: Scale.UnitTo, focusValueText: Boolean, listener: ScaleCalibrationPickerInspectorView.CalibrationPickerListener?)

Types

CalibrationPickerListener

fun interface CalibrationPickerListener

Listener for calibration value being picked.

Properties

propertyInspectorMaxHeight

open override val propertyInspectorMaxHeight: Int

propertyInspectorMinHeight

open override val propertyInspectorMinHeight: Int

suggestedHeight

open override val suggestedHeight: Int

view

open override val view: View

Functions

bindController

open override fun bindController(controller: PropertyInspectorController)

Bind to property inspector controller.

getLineAnnotation

fun getLineAnnotation(): LineAnnotation

The LineAnnotation that the scale calibration is being measured against.

getPropertyInspectorMaxHeight

open override fun getPropertyInspectorMaxHeight(): Int

Returns maximum height that this view with all its detail views will occupy.

getPropertyInspectorMinHeight

open override fun getPropertyInspectorMinHeight(): Int

Height of the parent PropertyInspector that this view would like it to have.

getSuggestedHeight

open override fun getSuggestedHeight(): Int

Returns best height of this view when shown in inspector. This is used to suggest initial height to inspector parent.

getView

open override fun getView(): View

Casts the inspector view to the View class and returns it.

setCalibration

fun setCalibration(value: Float?, unit: Scale.UnitTo, notifyListeners: Boolean)

Sets value to the calibration picker.

unbindController

open override fun unbindController()

Unbind from property inspector controller.

updateCalibration

fun updateCalibration(maybeScale: Scale?)

Updates the calibration picker UI from the given scale or from the annotation's current measurement scale if the provided scale is null.