Module com.esri.arcgisruntime

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

Class InteractionConfiguration

java.lang.Object

com.esri.arcgisruntime.mapping.view.geometryeditor.InteractionConfiguration

public final class InteractionConfiguration
extends Object

Defines the set of interactive operations you can enable or disable for a VertexTool, FreehandTool, or ShapeTool.

An InteractionConfiguration allows you to customize the interactive geometry editing experience to suit your specific users. For example:

• Disable vertex, mid-vertex, and part selection (allowVertexCreationProperty(), allowMidVertexSelectionProperty(), allowPartCreationProperty()) to define a tool to only move the complete geometry.
• Disable moving the selected element (allowMovingSelectedElementProperty()) but allow all selections, and provide a tool for a user to enter new coordinates instead of moving interactively.

You can tap multiple times on any GeometryEditorElement to select the different types of GeometryEditorElement representing vertices, parts, and the entire geometry. For example if all elements are allowed to be selected:

• Tap twice on a vertex of a Multipoint to select first the vertex and then the entire multipoint geometry
• Tap three times on a vertex of a Polyline or Polygon to select first the vertex, then the part, and then the entire geometry
• Tap twice on an edge of a Polyline or Polygon to select first the part and then the entire geometry
• Tap twice on a fill of a Polygon to select first the part and then the entire geometry

Depending on the values of InteractionConfiguration.allowMovingSelectedElementProperty(), allowRotatingSelectedElementProperty(), and allowScalingSelectedElementProperty(), visual handles are displayed to help the user move, rotate, or scale the selected element.

You can change the interaction properties of a tool at any point, including when a geometry editor is started (GeometryEditor.startedProperty() = true) and the tool is in use by the editor. If you change a property that disallows an in-progress interaction, then the interaction is cancelled and does not affect the state of the GeometryEditor.

Changing InteractionConfiguration properties affects whether types of interaction (such as tapping or dragging) to add new vertices or parts are enabled or not, but never affects the type of interaction used by each different GeometryEditorTool to create new vertices and parts. For example, a VertexTool adds vertices in response to a tap, whereas both FreehandTool and ShapeTool add parts in response to a drag operation but never in response to a tap.

Convenience methods are available to quickly set all properties relative to a category of interaction - for example use setAllowSelection(boolean) to change all selection interactions, and setAllowTransformation(boolean) to change all properties that control geometry transformation.

Since:

200.1.0

See Also:

• VertexTool.configurationProperty()
• FreehandTool.configurationProperty()
• ShapeTool.configurationProperty()
• setAllowSelection(boolean)
• setAllowTransformation(boolean)
• setAllowDeletion(boolean)

Property Summary

Properties

Type	Property	Description
BooleanProperty	allowDeletingSelectedElement	True if the selected GeometryEditorElement can be interactively deleted, false otherwise.
BooleanProperty	allowGeometrySelection	True if the entire geometry can be interactively selected, false otherwise.
BooleanProperty	allowMidVertexSelection	True if a mid-vertex of a polygon or polyline can be interactively selected, false otherwise.
BooleanProperty	allowMovingSelectedElement	True if the selected GeometryEditorElement can be interactively moved, false otherwise.
BooleanProperty	allowPartCreation	True if you can interactively create a new part in a polyline or polygon, false otherwise.
BooleanProperty	allowPartSelection	True to allow a part of a Multipart geometry (Polyline or Polygon) to be selected interactively, false otherwise.
BooleanProperty	allowRotatingSelectedElement	True to allow you to interactively rotate the selected GeometryEditorElement, false otherwise.
BooleanProperty	allowScalingSelectedElement	True to allow you to interactively scale the selected GeometryEditorElement, false otherwise.
BooleanProperty	allowVertexCreation	True to allow a vertex to be created interactively, false otherwise.
BooleanProperty	allowVertexSelection	True to allow vertices to be selected interactively, false otherwise.
BooleanProperty	requireSelectionBeforeMove	True to require a GeometryEditorElement to first be selected before it can be moved by interactively dragging, false otherwise.
ObjectProperty<GeometryEditorScaleMode>	scaleMode	Determines how a geometry can be interactively scaled (resized) to fill its allocated space while using the GeometryEditor.

Constructor Summary

Constructors

Constructor	Description
InteractionConfiguration()	Creates an InteractionConfiguration that enables selection, transformation and deletion.

Method Summary

Modifier and Type	Method	Description
BooleanProperty	allowDeletingSelectedElementProperty()	True if the selected GeometryEditorElement can be interactively deleted, false otherwise.
BooleanProperty	allowGeometrySelectionProperty()	True if the entire geometry can be interactively selected, false otherwise.
BooleanProperty	allowMidVertexSelectionProperty()	True if a mid-vertex of a polygon or polyline can be interactively selected, false otherwise.
BooleanProperty	allowMovingSelectedElementProperty()	True if the selected GeometryEditorElement can be interactively moved, false otherwise.
BooleanProperty	allowPartCreationProperty()	True if you can interactively create a new part in a polyline or polygon, false otherwise.
BooleanProperty	allowPartSelectionProperty()	True to allow a part of a Multipart geometry (Polyline or Polygon) to be selected interactively, false otherwise.
BooleanProperty	allowRotatingSelectedElementProperty()	True to allow you to interactively rotate the selected GeometryEditorElement, false otherwise.
BooleanProperty	allowScalingSelectedElementProperty()	True to allow you to interactively scale the selected GeometryEditorElement, false otherwise.
BooleanProperty	allowVertexCreationProperty()	True to allow a vertex to be created interactively, false otherwise.
BooleanProperty	allowVertexSelectionProperty()	True to allow vertices to be selected interactively, false otherwise.
GeometryEditorScaleMode	getScaleMode()	Gets the value of the scaleMode property.
boolean	isAllowDeletingSelectedElement()	Gets the value of the allowDeletingSelectedElement property.
boolean	isAllowGeometrySelection()	Gets the value of the allowGeometrySelection property.
boolean	isAllowMidVertexSelection()	Gets the value of the allowMidVertexSelection property.
boolean	isAllowMovingSelectedElement()	Gets the value of the allowMovingSelectedElement property.
boolean	isAllowPartCreation()	Gets the value of the allowPartCreation property.
boolean	isAllowPartSelection()	Gets the value of the allowPartSelection property.
boolean	isAllowRotatingSelectedElement()	Gets the value of the allowRotatingSelectedElement property.
boolean	isAllowScalingSelectedElement()	Gets the value of the allowScalingSelectedElement property.
boolean	isAllowVertexCreation()	Gets the value of the allowVertexCreation property.
boolean	isAllowVertexSelection()	Gets the value of the allowVertexSelection property.
boolean	isRequireSelectionBeforeMove()	Gets the value of the requireSelectionBeforeMove property.
BooleanProperty	requireSelectionBeforeMoveProperty()	True to require a GeometryEditorElement to first be selected before it can be moved by interactively dragging, false otherwise.
ObjectProperty<GeometryEditorScaleMode>	scaleModeProperty()	Determines how a geometry can be interactively scaled (resized) to fill its allocated space while using the GeometryEditor.
void	setAllowCreation(boolean allowCreation)	Set true to enable creation, or false to disable creation.
void	setAllowDeletingSelectedElement(boolean allowDeletingSelectedElement)	Sets the value of the allowDeletingSelectedElement property.
void	setAllowDeletion(boolean allowDeletion)	Set true to enable deletion, or false to disable deletion.
void	setAllowGeometrySelection(boolean allowGeometrySelection)	Sets the value of the allowGeometrySelection property.
void	setAllowMidVertexSelection(boolean allowMidVertexSelection)	Sets the value of the allowMidVertexSelection property.
void	setAllowMovingSelectedElement(boolean allowMovingSelectedElement)	Sets the value of the allowMovingSelectedElement property.
void	setAllowPartCreation(boolean allowPartCreation)	Sets the value of the allowPartCreation property.
void	setAllowPartSelection(boolean allowPartSelection)	Sets the value of the allowPartSelection property.
void	setAllowRotatingSelectedElement(boolean allowRotatingSelectedElement)	Sets the value of the allowRotatingSelectedElement property.
void	setAllowScalingSelectedElement(boolean allowScalingSelectedElement)	Sets the value of the allowScalingSelectedElement property.
void	setAllowSelection(boolean allowSelection)	Set true to enable selection, or false to disable selection.
void	setAllowTransformation(boolean allowTransformation)	Set true to enable interactions that transform the GeometryEditor.geometryProperty(), for example allowMovingSelectedElementProperty().
void	setAllowVertexCreation(boolean allowVertexCreation)	Sets the value of the allowVertexCreation property.
void	setAllowVertexSelection(boolean allowVertexSelection)	Sets the value of the allowVertexSelection property.
void	setRequireSelectionBeforeMove(boolean requireSelectionBeforeMove)	Sets the value of the requireSelectionBeforeMove property.
void	setScaleMode(GeometryEditorScaleMode scaleMode)	Sets the value of the scaleMode property.

Methods inherited from class java.lang.Object

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

Property Details

allowDeletingSelectedElement

public BooleanProperty allowDeletingSelectedElementProperty

True if the selected GeometryEditorElement can be interactively deleted, false otherwise. Default is true.

Whether true or false, an element can be deleted using GeometryEditor.deleteSelectedElement().

If true, then the GeometryEditorElement.canDeleteProperty() of the selected element is also true. If you have implemented a customization to allow users to interactively delete the selected element, then you can use this property to check if that customization should be enabled.

setAllowDeletion(boolean) sets this property.

Since:

200.1.0

See Also:

• isAllowDeletingSelectedElement()
• setAllowDeletingSelectedElement(boolean)
• allowDeletingSelectedElementProperty()

allowGeometrySelection

public BooleanProperty allowGeometrySelectionProperty

True if the entire geometry can be interactively selected, false otherwise. Default is true.

If true, you can tap multiple times on elements of the geometry to make the entire geometry selected.

Whether true or false, the entire geometry can be selected by GeometryEditor.selectGeometry().

setAllowSelection(boolean) sets this property.

Since:

200.1.0

See Also:

• isAllowGeometrySelection()
• setAllowGeometrySelection(boolean)
• allowGeometrySelectionProperty()

allowMidVertexSelection

public BooleanProperty allowMidVertexSelectionProperty

True if a mid-vertex of a polygon or polyline can be interactively selected, false otherwise. Default is true.

By default, mid-vertices (GeometryEditorMidVertex) are displayed and can be helpful in interactive workflows to provide a visual cue that new vertices can be inserted between the existing vertices of polygons and polylines. They may be most helpful for users with less editing experience.

If true, and allowVertexCreationProperty() is also true, then you can select and drag a mid-vertex to insert a vertex into the geometry and immediately move it to the required position.

If false, and you also do not intend to programmatically select any mid-vertices (GeometryEditor.selectMidVertex(long, long)) then set GeometryEditorStyle.midVertexSymbolProperty() to null to prevent the display of unusable mid-vertices.

Whether true or false, a mid-vertex can be selected by GeometryEditor.selectMidVertex(long, long).

setAllowSelection(boolean) sets this property.

Since:

200.1.0

See Also:

• isAllowMidVertexSelection()
• setAllowMidVertexSelection(boolean)
• allowMidVertexSelectionProperty()

allowMovingSelectedElement

public BooleanProperty allowMovingSelectedElementProperty

True if the selected GeometryEditorElement can be interactively moved, false otherwise. Default is true.

If true, you can use a drag gesture to move the selected GeometryEditorElement to the required location. Create a tool to allow moving only specific types of GeometryEditorElement by also allowing or disallowing the selection of different types of element (allowVertexSelectionProperty() for example).

If false, the behavior of a drag gesture depends on the current value of GeometryEditor.toolProperty(). A VertexTool will pan the map, whereas a FreehandTool will create a new part (depending on allowPartCreationProperty()).

If true, and the selected element is a GeometryEditorPart or a GeometryEditorGeometry with a geometry type of GeometryType.POLYLINE or GeometryType.POLYGON, then a bounding box is drawn using the GeometryEditorStyle.boundingBoxSymbolProperty().

setAllowTransformation(boolean) sets this property.

Since:

200.1.0

See Also:

• isAllowMovingSelectedElement()
• setAllowMovingSelectedElement(boolean)
• allowMovingSelectedElementProperty()

allowPartCreation

public BooleanProperty allowPartCreationProperty

True if you can interactively create a new part in a polyline or polygon, false otherwise. Default is true.

If true and the GeometryType of the GeometryEditor.geometryProperty() is a polygon or polyline, you can add new parts to the Multipart geometry - the tool determines the interaction required to add the new part. If the GeometryType of the geometry is a point or multipoint, this property is ignored. For new geometry creation (using GeometryEditor.start(GeometryType), or calling GeometryEditor.start(Geometry) with an empty geometry), this property is always ignored when adding the first part, and respected thereafter.

Users less experienced with GIS data may not understand how visually separate parts of polygons and polylines form a single geometry. You may wish to prevent such users from inadvertently creating geometries with multiple parts in order to keep their workflows straightforward and understandable. Alternatively, your app may be editing data which does not support multipart geometries.

setAllowCreation(boolean) sets this property.

Since:

200.1.0

See Also:

• isAllowPartCreation()
• setAllowPartCreation(boolean)
• allowPartCreationProperty()

allowPartSelection

public BooleanProperty allowPartSelectionProperty

True to allow a part of a Multipart geometry (Polyline or Polygon) to be selected interactively, false otherwise. Default is true.

If true, you can tap on the edge of a polygon or polyline GeometryEditorGeometry in order to the select the part.

Whether true or false, a part can be selected by GeometryEditor.selectPart(long). Parts are also selected after creation using a FreehandTool.

setAllowSelection(boolean) sets this property.

Since:

200.1.0

See Also:

• isAllowPartSelection()
• setAllowPartSelection(boolean)
• allowPartSelectionProperty()

allowRotatingSelectedElement

public BooleanProperty allowRotatingSelectedElementProperty

True to allow you to interactively rotate the selected GeometryEditorElement, false otherwise. Default is true.

This property applies when the GeometryEditor.selectedElementProperty() is:

• a GeometryEditorGeometry when GeometryEditor.geometryProperty() is a GeometryType.POLYGON, a GeometryType.POLYLINE, or a GeometryType.MULTIPOINT
• a GeometryEditorPart

For example, this does not apply if the selected element is a GeometryEditorVertex because a zero-dimensional geometry cannot be rotated.

When this property is true, and the GeometryEditor.selectedElementProperty() is rotatable, then a control handle is displayed (see GeometryEditorStyle.rotateHandleSymbolProperty()) that allows the selected element to be interactively rotated. The bounding box of the selected element is also displayed (GeometryEditorStyle.boundingBoxSymbolProperty()).

Interactive rotation changes the position of the selected element according to the movement of the rotation handle using the center of the extent of the selected element as the center of rotation (origin). Use GeometryEditor.rotateSelectedElement(double, Point) to rotate the selected element around a given origin.

setAllowTransformation(boolean) sets this property.

Since:

200.2.0

See Also:

• isAllowRotatingSelectedElement()
• setAllowRotatingSelectedElement(boolean)
• allowRotatingSelectedElementProperty()

allowScalingSelectedElement

public BooleanProperty allowScalingSelectedElementProperty

True to allow you to interactively scale the selected GeometryEditorElement, false otherwise. Default is true.

This property applies when the GeometryEditor.selectedElementProperty() is:

• a GeometryEditorGeometry when GeometryEditor.geometryProperty() is a GeometryType.POLYGON, a GeometryType.POLYLINE, or a GeometryType.MULTIPOINT
• a GeometryEditorPart

For example, this does not apply if the selected element is a GeometryEditorVertex because a zero-dimensional geometry cannot be scaled.

When this property is true, and the GeometryEditor.selectedElementProperty() is scalable, then control handles are displayed (see GeometryEditorStyle.boundingBoxHandleSymbolProperty()) that allow the selected element to be interactively scaled. The bounding box of the selected element is also displayed (GeometryEditorStyle.boundingBoxSymbolProperty()).

Interactive scaling changes the extent of the selected element according to the movement of the scale handle being moved - the opposite handle is used as the origin of the scale transformation. Use GeometryEditor.scaleSelectedElement(double, double, Point) to scale the selected element relative to a given origin.

setAllowTransformation(boolean) sets this property.

Since:

200.2.0

See Also:

• isAllowScalingSelectedElement()
• setAllowScalingSelectedElement(boolean)
• allowScalingSelectedElementProperty()

allowVertexCreation

public BooleanProperty allowVertexCreationProperty

True to allow a vertex to be created interactively, false otherwise. Default is true.

If true, you can tap on the map to add a new vertex. The vertex is inserted after the previously selected vertex, or as the first vertex if the previous selection was the first vertex in a Polyline. If you tap on an existing GeometryEditorElement then selection occurs instead.

A FreehandTool ignores this property as it does not create individual vertices; instead you use a freehand gesture to create a part in a polygon or polyline geometry.

Whether true or false, a vertex can be created by GeometryEditor.insertVertex(Point).

setAllowCreation(boolean) sets this property.

Since:

200.1.0

See Also:

• isAllowVertexCreation()
• setAllowVertexCreation(boolean)
• allowVertexCreationProperty()

allowVertexSelection

public BooleanProperty allowVertexSelectionProperty

True to allow vertices to be selected interactively, false otherwise. Default is true.

If true, you can tap on a vertex to select it.

To prevent vertices from being selected interactively by tapping on the vertex, while still allowing programmatic selection, set the value of the allowVertexSelectionProperty() to false.

Whether true or false, a vertex may still become selected in other ways, for example by a call to GeometryEditor.selectVertex(long, long), or when a new vertex is created.

setAllowSelection(boolean) sets this property.

Since:

200.1.0

See Also:

• isAllowVertexSelection()
• setAllowVertexSelection(boolean)
• allowVertexSelectionProperty()

requireSelectionBeforeMove

public BooleanProperty requireSelectionBeforeMoveProperty

True to require a GeometryEditorElement to first be selected before it can be moved by interactively dragging, false otherwise. Default is false.

By default, you can select and immediately move an element in one gesture. Some users may find this can lead to an increase in accidental element moves when editing. By setting this to true, this can reduce the possibility of accidental moves. Alternatively, you may wish to provide access to GeometryEditor.undo() and GeometryEditor.redo() to provide easy correction of accidental edits.

If false, the behavior of a drag gesture depends on the current tool. For a VertexTool, a drag gesture on the map over a geometry editor element that is not already selected pans the map, whereas a FreehandTool will create a new part (depending on allowPartCreationProperty()).

This property applies if and only if allowMovingSelectedElementProperty() is true.

Since:

200.1.0

See Also:

• isRequireSelectionBeforeMove()
• setRequireSelectionBeforeMove(boolean)
• requireSelectionBeforeMoveProperty()

scaleMode

public ObjectProperty<GeometryEditorScaleMode> scaleModeProperty

Determines how a geometry can be interactively scaled (resized) to fill its allocated space while using the GeometryEditor.

This property is ignored during geometry editing if allowScalingSelectedElementProperty() is false. It will be used to define how geometries are initially created by a drag interaction when the active tool is a ShapeTool regardless of the value of InteractionConfiguration.allowScalingSelectedElementProperty().

The scale control handles displayed to the user differ according to the value of this property.

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

Since:

200.2.0

See Also:

• getScaleMode()
• setScaleMode(GeometryEditorScaleMode)
• scaleModeProperty()

Constructor Details

InteractionConfiguration

public InteractionConfiguration()

Creates an InteractionConfiguration that enables selection, transformation and deletion.

Defines the most powerful and least restrictive interactive experience. When you create a new GeometryEditorTool, its InteractionConfiguration property defines the values appropriate for that type of tool, which may differ from the default values set by this constructor. For more information on the different default values for these tools, see VertexTool, FreehandTool, and ShapeTool.

Since:

200.1.0

See Also:

• VertexTool.configurationProperty()
• FreehandTool.configurationProperty()
• ShapeTool.configurationProperty()

Method Details

allowDeletingSelectedElementProperty

public BooleanProperty allowDeletingSelectedElementProperty()

True if the selected GeometryEditorElement can be interactively deleted, false otherwise. Default is true.

Whether true or false, an element can be deleted using GeometryEditor.deleteSelectedElement().

If true, then the GeometryEditorElement.canDeleteProperty() of the selected element is also true. If you have implemented a customization to allow users to interactively delete the selected element, then you can use this property to check if that customization should be enabled.

setAllowDeletion(boolean) sets this property.

Returns:

the allowDeletingSelectedElement property

Since:

200.1.0

See Also:

• isAllowDeletingSelectedElement()
• setAllowDeletingSelectedElement(boolean)

isAllowDeletingSelectedElement

public boolean isAllowDeletingSelectedElement()

Gets the value of the allowDeletingSelectedElement property.

Property description:

True if the selected GeometryEditorElement can be interactively deleted, false otherwise. Default is true.

Whether true or false, an element can be deleted using GeometryEditor.deleteSelectedElement().

If true, then the GeometryEditorElement.canDeleteProperty() of the selected element is also true. If you have implemented a customization to allow users to interactively delete the selected element, then you can use this property to check if that customization should be enabled.

setAllowDeletion(boolean) sets this property.

Returns:

the value of the allowDeletingSelectedElement property

Since:

200.1.0

See Also:

• setAllowDeletingSelectedElement(boolean)
• allowDeletingSelectedElementProperty()

setAllowDeletingSelectedElement

public void setAllowDeletingSelectedElement(boolean allowDeletingSelectedElement)

Sets the value of the allowDeletingSelectedElement property.

Property description:

True if the selected GeometryEditorElement can be interactively deleted, false otherwise. Default is true.

Whether true or false, an element can be deleted using GeometryEditor.deleteSelectedElement().

If true, then the GeometryEditorElement.canDeleteProperty() of the selected element is also true. If you have implemented a customization to allow users to interactively delete the selected element, then you can use this property to check if that customization should be enabled.

setAllowDeletion(boolean) sets this property.

Parameters:

allowDeletingSelectedElement - the value for the allowDeletingSelectedElement property

Since:

200.1.0

See Also:

• isAllowDeletingSelectedElement()
• allowDeletingSelectedElementProperty()

allowGeometrySelectionProperty

public BooleanProperty allowGeometrySelectionProperty()

True if the entire geometry can be interactively selected, false otherwise. Default is true.

If true, you can tap multiple times on elements of the geometry to make the entire geometry selected.

Whether true or false, the entire geometry can be selected by GeometryEditor.selectGeometry().

setAllowSelection(boolean) sets this property.

Returns:

the allowGeometrySelection property

Since:

200.1.0

See Also:

• isAllowGeometrySelection()
• setAllowGeometrySelection(boolean)

isAllowGeometrySelection

public boolean isAllowGeometrySelection()

Gets the value of the allowGeometrySelection property.

Property description:

True if the entire geometry can be interactively selected, false otherwise. Default is true.

If true, you can tap multiple times on elements of the geometry to make the entire geometry selected.

Whether true or false, the entire geometry can be selected by GeometryEditor.selectGeometry().

setAllowSelection(boolean) sets this property.

Returns:

the value of the allowGeometrySelection property

Since:

200.1.0

See Also:

• setAllowGeometrySelection(boolean)
• allowGeometrySelectionProperty()

setAllowGeometrySelection

public void setAllowGeometrySelection(boolean allowGeometrySelection)

Sets the value of the allowGeometrySelection property.

Property description:

True if the entire geometry can be interactively selected, false otherwise. Default is true.

If true, you can tap multiple times on elements of the geometry to make the entire geometry selected.

Whether true or false, the entire geometry can be selected by GeometryEditor.selectGeometry().

setAllowSelection(boolean) sets this property.

Parameters:

allowGeometrySelection - the value for the allowGeometrySelection property

Since:

200.1.0

See Also:

• isAllowGeometrySelection()
• allowGeometrySelectionProperty()

allowMidVertexSelectionProperty

public BooleanProperty allowMidVertexSelectionProperty()

True if a mid-vertex of a polygon or polyline can be interactively selected, false otherwise. Default is true.

By default, mid-vertices (GeometryEditorMidVertex) are displayed and can be helpful in interactive workflows to provide a visual cue that new vertices can be inserted between the existing vertices of polygons and polylines. They may be most helpful for users with less editing experience.

If true, and allowVertexCreationProperty() is also true, then you can select and drag a mid-vertex to insert a vertex into the geometry and immediately move it to the required position.

If false, and you also do not intend to programmatically select any mid-vertices (GeometryEditor.selectMidVertex(long, long)) then set GeometryEditorStyle.midVertexSymbolProperty() to null to prevent the display of unusable mid-vertices.

Whether true or false, a mid-vertex can be selected by GeometryEditor.selectMidVertex(long, long).

setAllowSelection(boolean) sets this property.

Returns:

the allowMidVertexSelection property

Since:

200.1.0

See Also:

• isAllowMidVertexSelection()
• setAllowMidVertexSelection(boolean)

isAllowMidVertexSelection

public boolean isAllowMidVertexSelection()

Gets the value of the allowMidVertexSelection property.

Property description:

True if a mid-vertex of a polygon or polyline can be interactively selected, false otherwise. Default is true.

By default, mid-vertices (GeometryEditorMidVertex) are displayed and can be helpful in interactive workflows to provide a visual cue that new vertices can be inserted between the existing vertices of polygons and polylines. They may be most helpful for users with less editing experience.

If true, and allowVertexCreationProperty() is also true, then you can select and drag a mid-vertex to insert a vertex into the geometry and immediately move it to the required position.

If false, and you also do not intend to programmatically select any mid-vertices (GeometryEditor.selectMidVertex(long, long)) then set GeometryEditorStyle.midVertexSymbolProperty() to null to prevent the display of unusable mid-vertices.

Whether true or false, a mid-vertex can be selected by GeometryEditor.selectMidVertex(long, long).

setAllowSelection(boolean) sets this property.

Returns:

the value of the allowMidVertexSelection property

Since:

200.1.0

See Also:

• setAllowMidVertexSelection(boolean)
• allowMidVertexSelectionProperty()

setAllowMidVertexSelection

public void setAllowMidVertexSelection(boolean allowMidVertexSelection)

Sets the value of the allowMidVertexSelection property.

Property description:

True if a mid-vertex of a polygon or polyline can be interactively selected, false otherwise. Default is true.

By default, mid-vertices (GeometryEditorMidVertex) are displayed and can be helpful in interactive workflows to provide a visual cue that new vertices can be inserted between the existing vertices of polygons and polylines. They may be most helpful for users with less editing experience.

If true, and allowVertexCreationProperty() is also true, then you can select and drag a mid-vertex to insert a vertex into the geometry and immediately move it to the required position.

If false, and you also do not intend to programmatically select any mid-vertices (GeometryEditor.selectMidVertex(long, long)) then set GeometryEditorStyle.midVertexSymbolProperty() to null to prevent the display of unusable mid-vertices.

Whether true or false, a mid-vertex can be selected by GeometryEditor.selectMidVertex(long, long).

setAllowSelection(boolean) sets this property.

Parameters:

allowMidVertexSelection - the value for the allowMidVertexSelection property

Since:

200.1.0

See Also:

• isAllowMidVertexSelection()
• allowMidVertexSelectionProperty()

allowMovingSelectedElementProperty

public BooleanProperty allowMovingSelectedElementProperty()

True if the selected GeometryEditorElement can be interactively moved, false otherwise. Default is true.

If true, you can use a drag gesture to move the selected GeometryEditorElement to the required location. Create a tool to allow moving only specific types of GeometryEditorElement by also allowing or disallowing the selection of different types of element (allowVertexSelectionProperty() for example).

If false, the behavior of a drag gesture depends on the current value of GeometryEditor.toolProperty(). A VertexTool will pan the map, whereas a FreehandTool will create a new part (depending on allowPartCreationProperty()).

If true, and the selected element is a GeometryEditorPart or a GeometryEditorGeometry with a geometry type of GeometryType.POLYLINE or GeometryType.POLYGON, then a bounding box is drawn using the GeometryEditorStyle.boundingBoxSymbolProperty().

setAllowTransformation(boolean) sets this property.

Returns:

the allowMovingSelectedElement property

Since:

200.1.0

See Also:

• isAllowMovingSelectedElement()
• setAllowMovingSelectedElement(boolean)

isAllowMovingSelectedElement

public boolean isAllowMovingSelectedElement()

Gets the value of the allowMovingSelectedElement property.

Property description:

True if the selected GeometryEditorElement can be interactively moved, false otherwise. Default is true.

If true, you can use a drag gesture to move the selected GeometryEditorElement to the required location. Create a tool to allow moving only specific types of GeometryEditorElement by also allowing or disallowing the selection of different types of element (allowVertexSelectionProperty() for example).

If false, the behavior of a drag gesture depends on the current value of GeometryEditor.toolProperty(). A VertexTool will pan the map, whereas a FreehandTool will create a new part (depending on allowPartCreationProperty()).

If true, and the selected element is a GeometryEditorPart or a GeometryEditorGeometry with a geometry type of GeometryType.POLYLINE or GeometryType.POLYGON, then a bounding box is drawn using the GeometryEditorStyle.boundingBoxSymbolProperty().

setAllowTransformation(boolean) sets this property.

Returns:

the value of the allowMovingSelectedElement property

Since:

200.1.0

See Also:

• setAllowMovingSelectedElement(boolean)
• allowMovingSelectedElementProperty()

setAllowMovingSelectedElement

public void setAllowMovingSelectedElement(boolean allowMovingSelectedElement)

Sets the value of the allowMovingSelectedElement property.

Property description:

True if the selected GeometryEditorElement can be interactively moved, false otherwise. Default is true.

If true, you can use a drag gesture to move the selected GeometryEditorElement to the required location. Create a tool to allow moving only specific types of GeometryEditorElement by also allowing or disallowing the selection of different types of element (allowVertexSelectionProperty() for example).

If false, the behavior of a drag gesture depends on the current value of GeometryEditor.toolProperty(). A VertexTool will pan the map, whereas a FreehandTool will create a new part (depending on allowPartCreationProperty()).

If true, and the selected element is a GeometryEditorPart or a GeometryEditorGeometry with a geometry type of GeometryType.POLYLINE or GeometryType.POLYGON, then a bounding box is drawn using the GeometryEditorStyle.boundingBoxSymbolProperty().

setAllowTransformation(boolean) sets this property.

Parameters:

allowMovingSelectedElement - the value for the allowMovingSelectedElement property

Since:

200.1.0

See Also:

• isAllowMovingSelectedElement()
• allowMovingSelectedElementProperty()

allowPartCreationProperty

public BooleanProperty allowPartCreationProperty()

True if you can interactively create a new part in a polyline or polygon, false otherwise. Default is true.

If true and the GeometryType of the GeometryEditor.geometryProperty() is a polygon or polyline, you can add new parts to the Multipart geometry - the tool determines the interaction required to add the new part. If the GeometryType of the geometry is a point or multipoint, this property is ignored. For new geometry creation (using GeometryEditor.start(GeometryType), or calling GeometryEditor.start(Geometry) with an empty geometry), this property is always ignored when adding the first part, and respected thereafter.

Users less experienced with GIS data may not understand how visually separate parts of polygons and polylines form a single geometry. You may wish to prevent such users from inadvertently creating geometries with multiple parts in order to keep their workflows straightforward and understandable. Alternatively, your app may be editing data which does not support multipart geometries.

setAllowCreation(boolean) sets this property.

Returns:

the allowPartCreation property

Since:

200.1.0

See Also:

• isAllowPartCreation()
• setAllowPartCreation(boolean)

isAllowPartCreation

public boolean isAllowPartCreation()

Gets the value of the allowPartCreation property.

Property description:

True if you can interactively create a new part in a polyline or polygon, false otherwise. Default is true.

If true and the GeometryType of the GeometryEditor.geometryProperty() is a polygon or polyline, you can add new parts to the Multipart geometry - the tool determines the interaction required to add the new part. If the GeometryType of the geometry is a point or multipoint, this property is ignored. For new geometry creation (using GeometryEditor.start(GeometryType), or calling GeometryEditor.start(Geometry) with an empty geometry), this property is always ignored when adding the first part, and respected thereafter.

Users less experienced with GIS data may not understand how visually separate parts of polygons and polylines form a single geometry. You may wish to prevent such users from inadvertently creating geometries with multiple parts in order to keep their workflows straightforward and understandable. Alternatively, your app may be editing data which does not support multipart geometries.

setAllowCreation(boolean) sets this property.

Returns:

the value of the allowPartCreation property

Since:

200.1.0

See Also:

• setAllowPartCreation(boolean)
• allowPartCreationProperty()

setAllowPartCreation

public void setAllowPartCreation(boolean allowPartCreation)

Sets the value of the allowPartCreation property.

Property description:

True if you can interactively create a new part in a polyline or polygon, false otherwise. Default is true.

If true and the GeometryType of the GeometryEditor.geometryProperty() is a polygon or polyline, you can add new parts to the Multipart geometry - the tool determines the interaction required to add the new part. If the GeometryType of the geometry is a point or multipoint, this property is ignored. For new geometry creation (using GeometryEditor.start(GeometryType), or calling GeometryEditor.start(Geometry) with an empty geometry), this property is always ignored when adding the first part, and respected thereafter.

Users less experienced with GIS data may not understand how visually separate parts of polygons and polylines form a single geometry. You may wish to prevent such users from inadvertently creating geometries with multiple parts in order to keep their workflows straightforward and understandable. Alternatively, your app may be editing data which does not support multipart geometries.

setAllowCreation(boolean) sets this property.

Parameters:

allowPartCreation - the value for the allowPartCreation property

Since:

200.1.0

See Also:

• isAllowPartCreation()
• allowPartCreationProperty()

allowPartSelectionProperty

public BooleanProperty allowPartSelectionProperty()

True to allow a part of a Multipart geometry (Polyline or Polygon) to be selected interactively, false otherwise. Default is true.

If true, you can tap on the edge of a polygon or polyline GeometryEditorGeometry in order to the select the part.

Whether true or false, a part can be selected by GeometryEditor.selectPart(long). Parts are also selected after creation using a FreehandTool.

setAllowSelection(boolean) sets this property.

Returns:

the allowPartSelection property

Since:

200.1.0

See Also:

• isAllowPartSelection()
• setAllowPartSelection(boolean)

isAllowPartSelection

public boolean isAllowPartSelection()

Gets the value of the allowPartSelection property.

Property description:

True to allow a part of a Multipart geometry (Polyline or Polygon) to be selected interactively, false otherwise. Default is true.

If true, you can tap on the edge of a polygon or polyline GeometryEditorGeometry in order to the select the part.

Whether true or false, a part can be selected by GeometryEditor.selectPart(long). Parts are also selected after creation using a FreehandTool.

setAllowSelection(boolean) sets this property.

Returns:

the value of the allowPartSelection property

Since:

200.1.0

See Also:

• setAllowPartSelection(boolean)
• allowPartSelectionProperty()

setAllowPartSelection

public void setAllowPartSelection(boolean allowPartSelection)

Sets the value of the allowPartSelection property.

Property description:

True to allow a part of a Multipart geometry (Polyline or Polygon) to be selected interactively, false otherwise. Default is true.

If true, you can tap on the edge of a polygon or polyline GeometryEditorGeometry in order to the select the part.

Whether true or false, a part can be selected by GeometryEditor.selectPart(long). Parts are also selected after creation using a FreehandTool.

setAllowSelection(boolean) sets this property.

Parameters:

allowPartSelection - the value for the allowPartSelection property

Since:

200.1.0

See Also:

• isAllowPartSelection()
• allowPartSelectionProperty()

allowRotatingSelectedElementProperty

public BooleanProperty allowRotatingSelectedElementProperty()

True to allow you to interactively rotate the selected GeometryEditorElement, false otherwise. Default is true.

This property applies when the GeometryEditor.selectedElementProperty() is:

• a GeometryEditorGeometry when GeometryEditor.geometryProperty() is a GeometryType.POLYGON, a GeometryType.POLYLINE, or a GeometryType.MULTIPOINT
• a GeometryEditorPart

For example, this does not apply if the selected element is a GeometryEditorVertex because a zero-dimensional geometry cannot be rotated.

When this property is true, and the GeometryEditor.selectedElementProperty() is rotatable, then a control handle is displayed (see GeometryEditorStyle.rotateHandleSymbolProperty()) that allows the selected element to be interactively rotated. The bounding box of the selected element is also displayed (GeometryEditorStyle.boundingBoxSymbolProperty()).

Interactive rotation changes the position of the selected element according to the movement of the rotation handle using the center of the extent of the selected element as the center of rotation (origin). Use GeometryEditor.rotateSelectedElement(double, Point) to rotate the selected element around a given origin.

setAllowTransformation(boolean) sets this property.

Returns:

the allowRotatingSelectedElement property

Since:

200.2.0

See Also:

• isAllowRotatingSelectedElement()
• setAllowRotatingSelectedElement(boolean)

isAllowRotatingSelectedElement

public boolean isAllowRotatingSelectedElement()

Gets the value of the allowRotatingSelectedElement property.

Property description:

True to allow you to interactively rotate the selected GeometryEditorElement, false otherwise. Default is true.

This property applies when the GeometryEditor.selectedElementProperty() is:

• a GeometryEditorGeometry when GeometryEditor.geometryProperty() is a GeometryType.POLYGON, a GeometryType.POLYLINE, or a GeometryType.MULTIPOINT
• a GeometryEditorPart

For example, this does not apply if the selected element is a GeometryEditorVertex because a zero-dimensional geometry cannot be rotated.

When this property is true, and the GeometryEditor.selectedElementProperty() is rotatable, then a control handle is displayed (see GeometryEditorStyle.rotateHandleSymbolProperty()) that allows the selected element to be interactively rotated. The bounding box of the selected element is also displayed (GeometryEditorStyle.boundingBoxSymbolProperty()).

Interactive rotation changes the position of the selected element according to the movement of the rotation handle using the center of the extent of the selected element as the center of rotation (origin). Use GeometryEditor.rotateSelectedElement(double, Point) to rotate the selected element around a given origin.

setAllowTransformation(boolean) sets this property.

Returns:

the value of the allowRotatingSelectedElement property

Since:

200.2.0

See Also:

• setAllowRotatingSelectedElement(boolean)
• allowRotatingSelectedElementProperty()

setAllowRotatingSelectedElement

public void setAllowRotatingSelectedElement(boolean allowRotatingSelectedElement)

Sets the value of the allowRotatingSelectedElement property.

Property description:

True to allow you to interactively rotate the selected GeometryEditorElement, false otherwise. Default is true.

This property applies when the GeometryEditor.selectedElementProperty() is:

• a GeometryEditorGeometry when GeometryEditor.geometryProperty() is a GeometryType.POLYGON, a GeometryType.POLYLINE, or a GeometryType.MULTIPOINT
• a GeometryEditorPart

For example, this does not apply if the selected element is a GeometryEditorVertex because a zero-dimensional geometry cannot be rotated.

When this property is true, and the GeometryEditor.selectedElementProperty() is rotatable, then a control handle is displayed (see GeometryEditorStyle.rotateHandleSymbolProperty()) that allows the selected element to be interactively rotated. The bounding box of the selected element is also displayed (GeometryEditorStyle.boundingBoxSymbolProperty()).

Interactive rotation changes the position of the selected element according to the movement of the rotation handle using the center of the extent of the selected element as the center of rotation (origin). Use GeometryEditor.rotateSelectedElement(double, Point) to rotate the selected element around a given origin.

setAllowTransformation(boolean) sets this property.

Parameters:

allowRotatingSelectedElement - the value for the allowRotatingSelectedElement property

Since:

200.2.0

See Also:

• isAllowRotatingSelectedElement()
• allowRotatingSelectedElementProperty()

allowScalingSelectedElementProperty

public BooleanProperty allowScalingSelectedElementProperty()

True to allow you to interactively scale the selected GeometryEditorElement, false otherwise. Default is true.

This property applies when the GeometryEditor.selectedElementProperty() is:

• a GeometryEditorGeometry when GeometryEditor.geometryProperty() is a GeometryType.POLYGON, a GeometryType.POLYLINE, or a GeometryType.MULTIPOINT
• a GeometryEditorPart

For example, this does not apply if the selected element is a GeometryEditorVertex because a zero-dimensional geometry cannot be scaled.

When this property is true, and the GeometryEditor.selectedElementProperty() is scalable, then control handles are displayed (see GeometryEditorStyle.boundingBoxHandleSymbolProperty()) that allow the selected element to be interactively scaled. The bounding box of the selected element is also displayed (GeometryEditorStyle.boundingBoxSymbolProperty()).

Interactive scaling changes the extent of the selected element according to the movement of the scale handle being moved - the opposite handle is used as the origin of the scale transformation. Use GeometryEditor.scaleSelectedElement(double, double, Point) to scale the selected element relative to a given origin.

setAllowTransformation(boolean) sets this property.

Returns:

the allowScalingSelectedElement property

Since:

200.2.0

See Also:

• isAllowScalingSelectedElement()
• setAllowScalingSelectedElement(boolean)

isAllowScalingSelectedElement

public boolean isAllowScalingSelectedElement()

Gets the value of the allowScalingSelectedElement property.

Property description:

True to allow you to interactively scale the selected GeometryEditorElement, false otherwise. Default is true.

This property applies when the GeometryEditor.selectedElementProperty() is:

• a GeometryEditorGeometry when GeometryEditor.geometryProperty() is a GeometryType.POLYGON, a GeometryType.POLYLINE, or a GeometryType.MULTIPOINT
• a GeometryEditorPart

For example, this does not apply if the selected element is a GeometryEditorVertex because a zero-dimensional geometry cannot be scaled.

When this property is true, and the GeometryEditor.selectedElementProperty() is scalable, then control handles are displayed (see GeometryEditorStyle.boundingBoxHandleSymbolProperty()) that allow the selected element to be interactively scaled. The bounding box of the selected element is also displayed (GeometryEditorStyle.boundingBoxSymbolProperty()).

Interactive scaling changes the extent of the selected element according to the movement of the scale handle being moved - the opposite handle is used as the origin of the scale transformation. Use GeometryEditor.scaleSelectedElement(double, double, Point) to scale the selected element relative to a given origin.

setAllowTransformation(boolean) sets this property.

Returns:

the value of the allowScalingSelectedElement property

Since:

200.2.0

See Also:

• setAllowScalingSelectedElement(boolean)
• allowScalingSelectedElementProperty()

setAllowScalingSelectedElement

public void setAllowScalingSelectedElement(boolean allowScalingSelectedElement)

Sets the value of the allowScalingSelectedElement property.

Property description:

True to allow you to interactively scale the selected GeometryEditorElement, false otherwise. Default is true.

This property applies when the GeometryEditor.selectedElementProperty() is:

• a GeometryEditorGeometry when GeometryEditor.geometryProperty() is a GeometryType.POLYGON, a GeometryType.POLYLINE, or a GeometryType.MULTIPOINT
• a GeometryEditorPart

For example, this does not apply if the selected element is a GeometryEditorVertex because a zero-dimensional geometry cannot be scaled.

When this property is true, and the GeometryEditor.selectedElementProperty() is scalable, then control handles are displayed (see GeometryEditorStyle.boundingBoxHandleSymbolProperty()) that allow the selected element to be interactively scaled. The bounding box of the selected element is also displayed (GeometryEditorStyle.boundingBoxSymbolProperty()).

Interactive scaling changes the extent of the selected element according to the movement of the scale handle being moved - the opposite handle is used as the origin of the scale transformation. Use GeometryEditor.scaleSelectedElement(double, double, Point) to scale the selected element relative to a given origin.

setAllowTransformation(boolean) sets this property.

Parameters:

allowScalingSelectedElement - the value for the allowScalingSelectedElement property

Since:

200.2.0

See Also:

• isAllowScalingSelectedElement()
• allowScalingSelectedElementProperty()

allowVertexCreationProperty

public BooleanProperty allowVertexCreationProperty()

True to allow a vertex to be created interactively, false otherwise. Default is true.

If true, you can tap on the map to add a new vertex. The vertex is inserted after the previously selected vertex, or as the first vertex if the previous selection was the first vertex in a Polyline. If you tap on an existing GeometryEditorElement then selection occurs instead.

A FreehandTool ignores this property as it does not create individual vertices; instead you use a freehand gesture to create a part in a polygon or polyline geometry.

Whether true or false, a vertex can be created by GeometryEditor.insertVertex(Point).

setAllowCreation(boolean) sets this property.

Returns:

the allowVertexCreation property

Since:

200.1.0

See Also:

• isAllowVertexCreation()
• setAllowVertexCreation(boolean)

isAllowVertexCreation

public boolean isAllowVertexCreation()

Gets the value of the allowVertexCreation property.

Property description:

True to allow a vertex to be created interactively, false otherwise. Default is true.

If true, you can tap on the map to add a new vertex. The vertex is inserted after the previously selected vertex, or as the first vertex if the previous selection was the first vertex in a Polyline. If you tap on an existing GeometryEditorElement then selection occurs instead.

A FreehandTool ignores this property as it does not create individual vertices; instead you use a freehand gesture to create a part in a polygon or polyline geometry.

Whether true or false, a vertex can be created by GeometryEditor.insertVertex(Point).

setAllowCreation(boolean) sets this property.

Returns:

the value of the allowVertexCreation property

Since:

200.1.0

See Also:

• setAllowVertexCreation(boolean)
• allowVertexCreationProperty()

setAllowVertexCreation

public void setAllowVertexCreation(boolean allowVertexCreation)

Sets the value of the allowVertexCreation property.

Property description:

True to allow a vertex to be created interactively, false otherwise. Default is true.

If true, you can tap on the map to add a new vertex. The vertex is inserted after the previously selected vertex, or as the first vertex if the previous selection was the first vertex in a Polyline. If you tap on an existing GeometryEditorElement then selection occurs instead.

A FreehandTool ignores this property as it does not create individual vertices; instead you use a freehand gesture to create a part in a polygon or polyline geometry.

Whether true or false, a vertex can be created by GeometryEditor.insertVertex(Point).

setAllowCreation(boolean) sets this property.

Parameters:

allowVertexCreation - the value for the allowVertexCreation property

Since:

200.1.0

See Also:

• isAllowVertexCreation()
• allowVertexCreationProperty()

allowVertexSelectionProperty

public BooleanProperty allowVertexSelectionProperty()

True to allow vertices to be selected interactively, false otherwise. Default is true.

If true, you can tap on a vertex to select it.

To prevent vertices from being selected interactively by tapping on the vertex, while still allowing programmatic selection, set the value of the allowVertexSelectionProperty() to false.

Whether true or false, a vertex may still become selected in other ways, for example by a call to GeometryEditor.selectVertex(long, long), or when a new vertex is created.

setAllowSelection(boolean) sets this property.

Returns:

the allowVertexSelection property

Since:

200.1.0

See Also:

• isAllowVertexSelection()
• setAllowVertexSelection(boolean)

isAllowVertexSelection

public boolean isAllowVertexSelection()

Gets the value of the allowVertexSelection property.

Property description:

True to allow vertices to be selected interactively, false otherwise. Default is true.

If true, you can tap on a vertex to select it.

To prevent vertices from being selected interactively by tapping on the vertex, while still allowing programmatic selection, set the value of the allowVertexSelectionProperty() to false.

Whether true or false, a vertex may still become selected in other ways, for example by a call to GeometryEditor.selectVertex(long, long), or when a new vertex is created.

setAllowSelection(boolean) sets this property.

Returns:

the value of the allowVertexSelection property

Since:

200.1.0

See Also:

• setAllowVertexSelection(boolean)
• allowVertexSelectionProperty()

setAllowVertexSelection

public void setAllowVertexSelection(boolean allowVertexSelection)

Sets the value of the allowVertexSelection property.

Property description:

True to allow vertices to be selected interactively, false otherwise. Default is true.

If true, you can tap on a vertex to select it.

To prevent vertices from being selected interactively by tapping on the vertex, while still allowing programmatic selection, set the value of the allowVertexSelectionProperty() to false.

Whether true or false, a vertex may still become selected in other ways, for example by a call to GeometryEditor.selectVertex(long, long), or when a new vertex is created.

setAllowSelection(boolean) sets this property.

Parameters:

allowVertexSelection - the value for the allowVertexSelection property

Since:

200.1.0

See Also:

• isAllowVertexSelection()
• allowVertexSelectionProperty()

requireSelectionBeforeMoveProperty

public BooleanProperty requireSelectionBeforeMoveProperty()

True to require a GeometryEditorElement to first be selected before it can be moved by interactively dragging, false otherwise. Default is false.

By default, you can select and immediately move an element in one gesture. Some users may find this can lead to an increase in accidental element moves when editing. By setting this to true, this can reduce the possibility of accidental moves. Alternatively, you may wish to provide access to GeometryEditor.undo() and GeometryEditor.redo() to provide easy correction of accidental edits.

If false, the behavior of a drag gesture depends on the current tool. For a VertexTool, a drag gesture on the map over a geometry editor element that is not already selected pans the map, whereas a FreehandTool will create a new part (depending on allowPartCreationProperty()).

This property applies if and only if allowMovingSelectedElementProperty() is true.

Returns:

the requireSelectionBeforeMove property

Since:

200.1.0

See Also:

• isRequireSelectionBeforeMove()
• setRequireSelectionBeforeMove(boolean)

isRequireSelectionBeforeMove

public boolean isRequireSelectionBeforeMove()

Gets the value of the requireSelectionBeforeMove property.

Property description:

True to require a GeometryEditorElement to first be selected before it can be moved by interactively dragging, false otherwise. Default is false.

By default, you can select and immediately move an element in one gesture. Some users may find this can lead to an increase in accidental element moves when editing. By setting this to true, this can reduce the possibility of accidental moves. Alternatively, you may wish to provide access to GeometryEditor.undo() and GeometryEditor.redo() to provide easy correction of accidental edits.

If false, the behavior of a drag gesture depends on the current tool. For a VertexTool, a drag gesture on the map over a geometry editor element that is not already selected pans the map, whereas a FreehandTool will create a new part (depending on allowPartCreationProperty()).

This property applies if and only if allowMovingSelectedElementProperty() is true.

Returns:

the value of the requireSelectionBeforeMove property

Since:

200.1.0

See Also:

• setRequireSelectionBeforeMove(boolean)
• requireSelectionBeforeMoveProperty()

setRequireSelectionBeforeMove

public void setRequireSelectionBeforeMove(boolean requireSelectionBeforeMove)

Sets the value of the requireSelectionBeforeMove property.

Property description:

True to require a GeometryEditorElement to first be selected before it can be moved by interactively dragging, false otherwise. Default is false.

By default, you can select and immediately move an element in one gesture. Some users may find this can lead to an increase in accidental element moves when editing. By setting this to true, this can reduce the possibility of accidental moves. Alternatively, you may wish to provide access to GeometryEditor.undo() and GeometryEditor.redo() to provide easy correction of accidental edits.

If false, the behavior of a drag gesture depends on the current tool. For a VertexTool, a drag gesture on the map over a geometry editor element that is not already selected pans the map, whereas a FreehandTool will create a new part (depending on allowPartCreationProperty()).

This property applies if and only if allowMovingSelectedElementProperty() is true.

Parameters:

requireSelectionBeforeMove - the value for the requireSelectionBeforeMove property

Since:

200.1.0

See Also:

• isRequireSelectionBeforeMove()
• requireSelectionBeforeMoveProperty()

scaleModeProperty

public ObjectProperty<GeometryEditorScaleMode> scaleModeProperty()

Determines how a geometry can be interactively scaled (resized) to fill its allocated space while using the GeometryEditor.

This property is ignored during geometry editing if allowScalingSelectedElementProperty() is false. It will be used to define how geometries are initially created by a drag interaction when the active tool is a ShapeTool regardless of the value of InteractionConfiguration.allowScalingSelectedElementProperty().

The scale control handles displayed to the user differ according to the value of this property.

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

Returns:

the scaleMode property

Since:

200.2.0

See Also:

• getScaleMode()
• setScaleMode(GeometryEditorScaleMode)

getScaleMode

public GeometryEditorScaleMode getScaleMode()

Gets the value of the scaleMode property.

Property description:

Determines how a geometry can be interactively scaled (resized) to fill its allocated space while using the GeometryEditor.

This property is ignored during geometry editing if allowScalingSelectedElementProperty() is false. It will be used to define how geometries are initially created by a drag interaction when the active tool is a ShapeTool regardless of the value of InteractionConfiguration.allowScalingSelectedElementProperty().

The scale control handles displayed to the user differ according to the value of this property.

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

Returns:

the value of the scaleMode property

Since:

200.2.0

See Also:

• setScaleMode(GeometryEditorScaleMode)
• scaleModeProperty()

setScaleMode

public void setScaleMode(GeometryEditorScaleMode scaleMode)

Sets the value of the scaleMode property.

Property description:

Determines how a geometry can be interactively scaled (resized) to fill its allocated space while using the GeometryEditor.

This property is ignored during geometry editing if allowScalingSelectedElementProperty() is false. It will be used to define how geometries are initially created by a drag interaction when the active tool is a ShapeTool regardless of the value of InteractionConfiguration.allowScalingSelectedElementProperty().

The scale control handles displayed to the user differ according to the value of this property.

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

Parameters:

scaleMode - the value for the scaleMode property

Since:

200.2.0

See Also:

• getScaleMode()
• scaleModeProperty()

setAllowCreation

public void setAllowCreation(boolean allowCreation)

Set true to enable creation, or false to disable creation.

Sets the following properties:

• allowVertexCreationProperty()
• allowPartCreationProperty()

Deletion, selection and transformation properties are unaltered.

Parameters:

allowCreation - true if creation is allowed, false otherwise.

Since:

200.1.0

setAllowDeletion

public void setAllowDeletion(boolean allowDeletion)

Set true to enable deletion, or false to disable deletion.

Sets the following properties:

• allowDeletingSelectedElementProperty()

Creation, selection and transformation properties are unaltered.

Parameters:

allowDeletion - true if deletion is allowed, false otherwise.

Since:

200.1.0

setAllowSelection

public void setAllowSelection(boolean allowSelection)

Set true to enable selection, or false to disable selection.

Sets the following properties:

• allowGeometrySelectionProperty()
• allowMidVertexSelectionProperty()
• allowPartSelectionProperty()
• allowVertexSelectionProperty()

Creation, deletion and transformation properties are unaltered.

Parameters:

allowSelection - true if selection is allowed, false otherwise.

Since:

200.1.0

setAllowTransformation

public void setAllowTransformation(boolean allowTransformation)

Set true to enable interactions that transform the GeometryEditor.geometryProperty(), for example allowMovingSelectedElementProperty(). Set false to disable.

Sets the following properties:

• allowMovingSelectedElementProperty()
• allowRotatingSelectedElementProperty()
• allowScalingSelectedElementProperty()

Creation, deletion and selection properties are unaltered.

Parameters:

allowTransformation - true if transformation is allowed, false otherwise.

Since:

200.1.0