Package com.luciad.edit.geometries

Class PolygonHandlesProvider

java.lang.Object

com.luciad.edit.geometries.PolygonHandlesProvider

All Implemented Interfaces:

IGeometryHandlesProvider, AutoCloseable

public final class PolygonHandlesProvider
extends Object
implements AutoCloseable, IGeometryHandlesProvider

This handles provider can create handles to edit Polygon geometries.

It delegates its handle creation to a delegate IGeometryHandlesProvider for its exterior and interior PolylineRing instances.

Note: the handle to translate the entire feature is typically created by the IFeatureHandlesProvider. FeatureHandlesProvider does this by default.

Limitations of this handle provider:

• it does not create a handle to remove interior PolylineRing instances
• it does not create a handle to add new interior PolylineRing instances
• it does not prevent you from modifying the PolylineRing instances that overlap with other PolylineRing instances, or that self-overlap.

Since:

2024.0.04

Constructor Summary

Constructors

Constructor	Description
PolygonHandlesProvider()	Creates a new handles provider that can create handles for a Polygon geometry.

Method Summary

Modifier and Type	Method	Description
boolean	canProvide(Observable<@Nullable Geometry> geometry, FeatureEditContext context)	Indicates if this handles provider can create handles for the given geometry.
void	close()
protected void	finalize()
IGeometryHandlesProvider	getPolylineRingHandlesProvider()	Returns the IGeometryHandlesProvider that is used to provide handles for exterior and interior PolylineRing instances.
IEditHandles	provide(Observable<@Nullable Geometry> geometry, FeatureEditContext context, IGeometryEditCallback geometryEditCallback)	Returns the handles for the given feature.
ITranslateEditAction	provideTranslateAction(Observable<@Nullable Geometry> geometry, FeatureEditContext context, IGeometryEditCallback geometryEditCallback)	Provides a translate action that can be used by the caller to add translation behavior.
void	setPolylineRingHandlesProvider(IGeometryHandlesProvider provider)	Sets the IGeometryHandlesProvider that is used to provide handles for the exterior and interior PolylineRing instances.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PolygonHandlesProvider

public PolygonHandlesProvider()

Creates a new handles provider that can create handles for a Polygon geometry.

Method Details

finalize

protected void finalize()

Overrides:

finalize in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

canProvide

public boolean canProvide(@NotNull
 Observable<@Nullable Geometry> geometry,
 @NotNull
 FeatureEditContext context)

Indicates if this handles provider can create handles for the given geometry.

Specified by:

canProvide in interface IGeometryHandlesProvider

Parameters:

geometry - an observable geometry, cannot be null

context - the context. Contains additional information about the edited feature, cannot be null.

Returns:

if this handles provider can provide handles and a translate action for the given Feature

provide

@NotNull
public IEditHandles provide(@NotNull
 Observable<@Nullable Geometry> geometry,
 @NotNull
 FeatureEditContext context,
 @NotNull
 IGeometryEditCallback geometryEditCallback)

Returns the handles for the given feature.

Note: translation of features is handled by IFeatureHandlesProvider. So geometry handles providers should not provide handles to translate a geometry.

Specified by:

provide in interface IGeometryHandlesProvider

Parameters:

geometry - the observable geometry for which to provide handles, cannot be null.

context - the context. Contains additional information about the edited feature, cannot be null.

geometryEditCallback - a callback that notifies the caller when the Feature has changed, cannot be null.

Returns:

handles for the given feature. Never null.

provideTranslateAction

@NotNull
public ITranslateEditAction provideTranslateAction(@NotNull
 Observable<@Nullable Geometry> geometry,
 @NotNull
 FeatureEditContext context,
 @NotNull
 IGeometryEditCallback geometryEditCallback)

Provides a translate action that can be used by the caller to add translation behavior.

A translation handle is typically added by an IFeatureHandlesProvider, like for example the FeatureHandlesProvider implementation. It calls this method to retrieve a translate action, and uses it to create a TranslateEditHandle.

When ITranslateEditAction#translate is called, the returned implementation must:

• apply a translation on the geometry
• apply this IGeometryHandlesProvider's constraint (if configured) on the translated geometry
• call IGeometryEditCallback with the resulting geometry

Specified by:

provideTranslateAction in interface IGeometryHandlesProvider

Parameters:

geometry - the observable geometry for which to provide a translate action, cannot be null

context - the context, cannot be null

geometryEditCallback - a callback that notifies the caller of this method when a translation has occurred, cannot be null

Returns:

a translate action. Never null.

setPolylineRingHandlesProvider

public void setPolylineRingHandlesProvider(@NotNull
 IGeometryHandlesProvider provider)
                                    throws NullPointerException

Sets the IGeometryHandlesProvider that is used to provide handles for the exterior and interior PolylineRing instances.

If this method is not called, a default implementation is used.

Parameters:

provider - the IGeometryHandlesProvider to use, cannot be null.

Throws:

NullPointerException - when null is passed.

getPolylineRingHandlesProvider

@NotNull
public IGeometryHandlesProvider getPolylineRingHandlesProvider()

Returns the IGeometryHandlesProvider that is used to provide handles for exterior and interior PolylineRing instances.

Returns:

the IGeometryHandlesProvider that is used to provide handles for exterior and interior PolylineRing instances.

See Also:

• PolygonHandlesProvider#setPolylineRingHandlesProvider