Package com.luciad.edit.geometries

Interface PolylineRingHandlesProvider.IHandleFactory

Enclosing class:
PolylineRingHandlesProvider
public static interface PolylineRingHandlesProvider.IHandleFactory
Allows you to specify which handles are used 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 PolylineRingHandlesProvider, and to insert additional handles in the IEditHandles#getList method.

  • Method Details

    • createMovePointHandle

      @Nullable IEditHandle createMovePointHandle(@NotNull Observable<@Nullable PolylineRing> polylineRing, long pointIndex, @NotNull IPointEditAction editAction, @NotNull FeatureEditContext context)
      Creates a handle that allows you to move a point of the PolylineRing.

      While the handle is not already present, this method is called whenever the edited geometry changes.

      Parameters:
      polylineRing - the Geometry that is being edited
      pointIndex - the index of the point to move
      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 PolylineChange parameter with one moved point index.
      context - the context
      Returns:
      a new handle, or null if no handle should be used

    • isMovePointHandleValid

      boolean isMovePointHandleValid(@NotNull IEditHandle movePointHandle, @NotNull Observable<@Nullable PolylineRing> polylineRing, long pointIndex, @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 createMovePointHandle 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:
      movePointHandle - the handle
      polylineRing - the Geometry that is being edited
      pointIndex - the index of the point
      context - the context
      Returns:
      true if the given handle is still valid, or false if it should be removed.

    • createRemovePointHandle

      @Nullable IEditHandle createRemovePointHandle(@NotNull Observable<@Nullable PolylineRing> polylineRing, long pointIndex, @NotNull IPointEditAction editAction, @NotNull FeatureEditContext context)
      Creates a handle that allows you to remove a point of the PolylineRing.

      While the handle is not already present, this method is called whenever the edited geometry changes.

      Parameters:
      polylineRing - the Geometry that is being edited
      pointIndex - the index of the point to remove
      editAction - the remove-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 PolylineChange parameter with one removed point index.
      context - the context
      Returns:
      a new handle, or null if no handle should be used

    • isRemovePointHandleValid

      boolean isRemovePointHandleValid(@NotNull IEditHandle removePointHandle, @NotNull Observable<PolylineRing> polylineRing, long pointIndex, @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 createRemovePointHandle 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:
      removePointHandle - the handle
      polylineRing - the Geometry that is being edited
      pointIndex - the index of the point
      context - the context
      Returns:
      true if the given handle is still valid, or false if it should be removed.

    • createInsertPointHandle

      @Nullable IEditHandle createInsertPointHandle(@NotNull Observable<@Nullable PolylineRing> polylineRing, long insertIndex, @NotNull IPointEditAction editAction, @NotNull FeatureEditContext context)
      Creates a handle that allows you to insert a new point in a PolylineRing.

      While the handle is not already present, this method is called whenever the edited geometry changes.

      Parameters:
      polylineRing - the Geometry that is being edited
      insertIndex - the index at which to insert a point in the Polyline. After the point is inserted, the new point will have this index. Values are within [1, pointCount].
      editAction - the edit action that inserts the point. If a constraint was configured on the handles provider, this action applies that constraint when it is executed, providing a PolylineChange parameter with one inserted point index.
      context - the context
      Returns:
      a new handle, or null if no handle should be used

    • isInsertPointHandleValid

      boolean isInsertPointHandleValid(@NotNull IEditHandle insertPointHandle, @NotNull Observable<PolylineRing> polylineRing, long insertIndex, @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 createInsertPointHandle 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:
      insertPointHandle - the handle
      polylineRing - the Geometry that is being edited
      insertIndex - the insertion index
      context - the context
      Returns:
      true if the given handle is still valid, or false if it should be removed.