Package io.jmix.mapsflowui.kit.component.model.source

Interface SupportsFeatureDelete

All Known Subinterfaces:
HasFeatureDelete
All Known Implementing Classes:
DataVectorSource, HeatmapDataVectorSource, NoOpVectorSource, VectorSource
public interface SupportsFeatureDelete
Implemented by sources whose whole-object deletion can be enabled independently of modify mode. When deletion is effectively enabled, a Delete button is offered in the map's control panel.

The flag is tri-state: an explicit value always applies, while the unset (default) state follows the map-wide "modify includes delete" compatibility setting (jmix.maps.ui.feature-modify-includes-delete) — see getFeatureDeleteEnabled().

  • Method Summary

    Modifier and Type
    Method
    Description
    Boolean
    getFeatureDeleteEnabled()
    Returns the effective deletion state, resolving the tri-state flag: an explicit true/false is returned as-is, while an unset flag follows modify mode only when the map-wide compatibility setting jmix.maps.ui.feature-modify-includes-delete is on.
    void
    setFeatureDeleteEnabled(Boolean enabled)
    Enables (true) or disables (false) deletion explicitly, overriding the compatibility default; null clears the choice back to unset, letting the map-wide setting decide (see getFeatureDeleteEnabled()).

  • Method Details

    • getFeatureDeleteEnabled

      Boolean getFeatureDeleteEnabled()
      Returns the effective deletion state, resolving the tri-state flag: an explicit true/false is returned as-is, while an unset flag follows modify mode only when the map-wide compatibility setting jmix.maps.ui.feature-modify-includes-delete is on. 
        featureDeleteEnabled | compat | modify | result
  ---------------------+--------+--------+-------
  unset (null)         | false  | any    | false
  unset (null)         | true   | false  | false
  unset (null)         | true   | true   | true
  false                | any    | any    | false
  true                 | any    | any    | true
      (compat = jmix.maps.ui.feature-modify-includes-delete.)
      Returns:
      whether deletion is effectively enabled for this source

    • setFeatureDeleteEnabled

      void setFeatureDeleteEnabled(Boolean enabled)
      Enables (true) or disables (false) deletion explicitly, overriding the compatibility default; null clears the choice back to unset, letting the map-wide setting decide (see getFeatureDeleteEnabled()).

      The default is unset (null).

      Parameters:
      enabled - true/false to force the state, or null for unset