Module com.esri.arcgisruntime

Package com.esri.arcgisruntime.mapping.view.geometryeditor

Class FreehandTool

java.lang.Object

com.esri.arcgisruntime.mapping.view.geometryeditor.GeometryEditorTool

com.esri.arcgisruntime.mapping.view.geometryeditor.FreehandTool

public final class FreehandTool
extends GeometryEditorTool

Allows you to edit geometries in a GeometryEditor by using freehand gestures.

This tool is suitable for creating and editing Polygon and Polyline geometries. Each drag gesture creates a new part of the Multipart geometry.

By default, this tool does not display vertices or mid-vertices. This behavior can be customized with GeometryEditorTool.styleProperty().

Since:

200.1.0

See Also:

• VertexTool
• ShapeTool

Property Summary

Properties

Type	Property	Description
ObjectProperty<InteractionConfiguration>	configuration	Defines the set of interactive operations enabled when using this tool.

Properties inherited from class com.esri.arcgisruntime.mapping.view.geometryeditor.GeometryEditorTool

style

Constructor Summary

Constructors

Constructor	Description
FreehandTool()	Creates a new FreehandTool.

Method Summary

Modifier and Type	Method	Description
ObjectProperty<InteractionConfiguration>	configurationProperty()	Defines the set of interactive operations enabled when using this tool.
InteractionConfiguration	getConfiguration()	Gets the value of the configuration property.
void	setConfiguration(InteractionConfiguration configuration)	Sets the value of the configuration property.

Methods inherited from class com.esri.arcgisruntime.mapping.view.geometryeditor.GeometryEditorTool

getStyle, setStyle, styleProperty

Methods inherited from class java.lang.Object

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

Property Details

configuration

public ObjectProperty<InteractionConfiguration> configurationProperty

Defines the set of interactive operations enabled when using this tool.

By default, the configurationProperty() allows creation and selection of parts, transformation, and deletion operations.

This tool ignores the InteractionConfiguration.allowVertexCreationProperty().

Attempting to set the value to null will throw a NullPointerException.

Since:

200.1.0

See Also:

• getConfiguration()
• setConfiguration(InteractionConfiguration)
• configurationProperty()

Constructor Details

FreehandTool

public FreehandTool()

Creates a new FreehandTool.

By default, this tool enables the creation, selection, transformation, and deletion interactions appropriate for creating and editing geometries using freehand gestures. This behavior can be customized with configurationProperty().

Since:

200.1.0

Method Details

configurationProperty

public ObjectProperty<InteractionConfiguration> configurationProperty()

Defines the set of interactive operations enabled when using this tool.

By default, the configurationProperty() allows creation and selection of parts, transformation, and deletion operations.

This tool ignores the InteractionConfiguration.allowVertexCreationProperty().

Attempting to set the value to null will throw a NullPointerException.

Returns:

the configuration property

Since:

200.1.0

See Also:

• getConfiguration()
• setConfiguration(InteractionConfiguration)

getConfiguration

public InteractionConfiguration getConfiguration()

Gets the value of the configuration property.

Property description:

Defines the set of interactive operations enabled when using this tool.

By default, the configurationProperty() allows creation and selection of parts, transformation, and deletion operations.

This tool ignores the InteractionConfiguration.allowVertexCreationProperty().

Attempting to set the value to null will throw a NullPointerException.

Returns:

the value of the configuration property

Since:

200.1.0

See Also:

• setConfiguration(InteractionConfiguration)
• configurationProperty()

setConfiguration

public void setConfiguration(InteractionConfiguration configuration)

Sets the value of the configuration property.

Property description:

Defines the set of interactive operations enabled when using this tool.

By default, the configurationProperty() allows creation and selection of parts, transformation, and deletion operations.

This tool ignores the InteractionConfiguration.allowVertexCreationProperty().

Attempting to set the value to null will throw a NullPointerException.

Parameters:

configuration - the value for the configuration property

Since:

200.1.0

See Also:

• getConfiguration()
• configurationProperty()