Interface FeatureHandlesProvider.IHandleFactory

Enclosing class:
FeatureHandlesProvider

public static interface FeatureHandlesProvider.IHandleFactory
Allows you to specify the translate handle that is used by this handles provider.

It allows you to:

  • replace the handle with another handle implementation
  • (dynamically) disable or re-enable the translation handles

Note: Other handles are created by the delegate geometry handles provider.

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

  • Method Details

    • createTranslateHandle

      @Nullable IEditHandle createTranslateHandle(@NotNull Observable<Feature> feature, @NotNull Observable<Geometry> geometry, @NotNull ITranslateEditAction editAction, @NotNull FeatureEditContext context)
      Creates a handle that allows you to translate the entire Geometry.

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

      Parameters:
      feature - the feature that is being edited
      geometry - the feature's Geometry that is being edited
      editAction - the translate edit action, to be used by the handle. If a constraint was configured on the delegate geometry handles provider, this action applies that constraint when it is executed.
      context - the context
      Returns:
      a new handle, or null if no handle should be used
    • isTranslateHandleValid

      boolean isTranslateHandleValid(@NotNull IEditHandle translateHandle, @NotNull Observable<Feature> feature, @NotNull Observable<Geometry> geometry, @NotNull FeatureEditContext context)
      Returns true if the translate 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 the edit handles. When this method returns false, the handle is removed and createTranslateHandle 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:
      translateHandle - the handle
      feature - the feature that is being edited
      geometry - the feature's Geometry that is being edited
      context - the context
      Returns:
      true if the given handle is still valid, or false if it should be removed.