Interface PointHandlesProvider.IHandleFactory

Enclosing class:
PointHandlesProvider

public static interface PointHandlesProvider.IHandleFactory
Allows you to specify which handles are created by this handles provider.

It allows you to

  • replace handles with other handle implementations
  • (dynamically) disable or re-enable specific handles

Additional handles can not be added using this factory. The way to do this is to wrap the IEditHandles provided by PointHandlesProvider, and to insert additional handles in the IEditHandles#getList method.

  • Method Details

    • createElevationPointHandle

      @Nullable IEditHandle createElevationPointHandle(@NotNull Observable<@Nullable Point> point, @NotNull IPointEditAction editAction, @NotNull FeatureEditContext context)
      Creates a handle that allows you to move the Point vertically.

      This method is only called when a 3D Map is used. While the handle is not already present, this method is called whenever the edited geometry changes.

      Parameters:
      point - the geometry that is being edited
      editAction - the move-point edit action, to be used by the handle. If a constraint was configured on the handles provider, this action applies that constraint when it is executed, providing a PointChange parameter with the translation.
      context - the context
      Returns:
      a new handle, or null if no handle should be used
    • isElevationPointHandleValid

      boolean isElevationPointHandleValid(@NotNull IEditHandle elevationHandle, @NotNull Observable<@Nullable Point> point, @NotNull FeatureEditContext context)
      Returns true if the given handle is still valid, or false if it should be removed.

      This method is called whenever the edited geometry changes and allows the factory to dynamically disable or re-create specific edit handles. When this method returns false, the handle is removed and createElevationPointHandle is called, in case the handle should immediately be re-created. If the handle should remain absent, make sure to also return null in that method.

      Parameters:
      elevationHandle - the handle
      point - the Geometry that is being edited
      context - the context
      Returns:
      true if the given handle is still valid, or false if it should be removed.