Package com.luciad.edit.geometries

Class PatchHandlesProvider

java.lang.Object

com.luciad.edit.geometries.PatchHandlesProvider

All Implemented Interfaces:

IGeometryHandlesProvider, AutoCloseable

public final class PatchHandlesProvider
extends Object
implements AutoCloseable, IGeometryHandlesProvider

This handles provider can be used to provider edit handles for a Patch geometry.

It delegates handle creation to a handles provider for the base geometry.

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

Constructor Summary

Constructors

Constructor	Description
PatchHandlesProvider()	Creates a new handles provider that can provide handles a Patch 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	getGeometryHandlesProvider()	Returns the IGeometryHandlesProvider that is used to provide handles for the base geometry.
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	setGeometryHandlesProvider(IGeometryHandlesProvider handlesProvider)	Sets the IGeometryHandlesProvider that is used to provide handles for the base geometry.

Methods inherited from class java.lang.Object

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

Constructor Details

PatchHandlesProvider

public PatchHandlesProvider()

Creates a new handles provider that can provide handles a Patch 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.

setGeometryHandlesProvider

public void setGeometryHandlesProvider(@NotNull
 IGeometryHandlesProvider handlesProvider)
                                throws NullPointerException

Sets the IGeometryHandlesProvider that is used to provide handles for the base geometry.

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

Parameters:

handlesProvider - the IGeometryHandlesProvider to use, cannot be null.

Throws:

NullPointerException - when null is passed.

getGeometryHandlesProvider

@NotNull
public IGeometryHandlesProvider getGeometryHandlesProvider()

Returns the IGeometryHandlesProvider that is used to provide handles for the base geometry.

Returns:

the IGeometryHandlesProvider that is used to provide handles for the base geometry.

See Also:

• PatchHandlesProvider#setGeometryHandlesProvider