Module com.esri.arcgisruntime

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

Class GeometryEditorElement

java.lang.Object

com.esri.arcgisruntime.mapping.view.geometryeditor.GeometryEditorElement

Direct Known Subclasses:

GeometryEditorGeometry, GeometryEditorMidVertex, GeometryEditorPart, GeometryEditorVertex

public class GeometryEditorElement
extends Object

The base class for all selectable elements in a GeometryEditor.

The selected element is an object that inherits from this base class, representing the specific type of element that is selected.

Since:

200.1.0

Property Summary

Properties

Type	Property	Description
ReadOnlyBooleanProperty	canDelete	True if this element can be deleted interactively, false otherwise.
ReadOnlyBooleanProperty	canMove	True if this element can be moved interactively, false otherwise.
ReadOnlyBooleanProperty	canRotate	True if this element can be rotated interactively, false otherwise.
ReadOnlyBooleanProperty	canScale	True if this element can be scaled interactively, false otherwise.
ReadOnlyObjectProperty<Envelope>	extent	The extent of the selected element in the SpatialReference of the associated MapView.

Method Summary

Modifier and Type	Method	Description
ReadOnlyBooleanProperty	canDeleteProperty()	True if this element can be deleted interactively, false otherwise.
ReadOnlyBooleanProperty	canMoveProperty()	True if this element can be moved interactively, false otherwise.
ReadOnlyBooleanProperty	canRotateProperty()	True if this element can be rotated interactively, false otherwise.
ReadOnlyBooleanProperty	canScaleProperty()	True if this element can be scaled interactively, false otherwise.
ReadOnlyObjectProperty<Envelope>	extentProperty()	The extent of the selected element in the SpatialReference of the associated MapView.
boolean	getCanDelete()	Gets the value of the canDelete property.
boolean	getCanMove()	Gets the value of the canMove property.
boolean	getCanRotate()	Gets the value of the canRotate property.
boolean	getCanScale()	Gets the value of the canScale property.
Envelope	getExtent()	Gets the value of the extent property.

Methods inherited from class java.lang.Object

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

Property Details

canDelete

public ReadOnlyBooleanProperty canDeleteProperty

True if this element can be deleted interactively, false otherwise.

The value of InteractionConfiguration.allowDeletingSelectedElementProperty() of the current tool determines this value. The element can be deleted programmatically regardless of this value, for example using GeometryEditor.deleteSelectedElement().

A GeometryEditorMidVertex is not part of the geometry state, and therefore can never be deleted from the geometry regardless of the InteractionConfiguration settings.

Since:

200.1.0

See Also:

• getCanDelete()
• canDeleteProperty()

canMove

public ReadOnlyBooleanProperty canMoveProperty

True if this element can be moved interactively, false otherwise.

The value of the InteractionConfiguration.allowMovingSelectedElementProperty() of the current tool determines this value. The element can be moved programmatically regardless of this value, for example using GeometryEditor.moveSelectedElement(Point).

A GeometryEditorMidVertex is not part of the geometry state, and therefore can never be moved regardless of the InteractionConfiguration settings.

Since:

200.1.0

See Also:

• getCanMove()
• canMoveProperty()

canRotate

public ReadOnlyBooleanProperty canRotateProperty

True if this element can be rotated interactively, false otherwise.

The value of InteractionConfiguration.allowRotatingSelectedElementProperty() of the current GeometryEditor.toolProperty() determines this value. The element can be rotated programmatically regardless of this value, for example using GeometryEditor.rotateSelectedElement(double, Point).

The following can never be rotated interactively, regardless of the InteractionConfiguration settings:

• GeometryEditorVertex
• GeometryEditorMidVertex
• GeometryEditorGeometry when the geometry type is GeometryType.POINT.

Since:

200.2.0

See Also:

• getCanRotate()
• canRotateProperty()

canScale

public ReadOnlyBooleanProperty canScaleProperty

True if this element can be scaled interactively, false otherwise.

The value of InteractionConfiguration.allowScalingSelectedElementProperty() of the current GeometryEditor.toolProperty() determines this value. The element can be scaled programmatically regardless of this value, for example using GeometryEditor.scaleSelectedElement(double, double, Point).

The following can never be scaled interactively, regardless of the InteractionConfiguration settings:

• GeometryEditorVertex
• GeometryEditorMidVertex
• GeometryEditorGeometry when the geometry type is GeometryType.POINT.

Since:

200.2.0

See Also:

• getCanScale()
• canScaleProperty()

extent

public ReadOnlyObjectProperty<Envelope> extentProperty

The extent of the selected element in the SpatialReference of the associated MapView.

To find the specific shape of the selected element instead of its extent, use the GeometryEditorGeometry.geometryProperty(), GeometryEditorMidVertex.pointProperty(), GeometryEditorPart.partProperty(), or GeometryEditorVertex.pointProperty().

Since:

200.1.0

See Also:

• getExtent()
• extentProperty()

Method Details

canDeleteProperty

public ReadOnlyBooleanProperty canDeleteProperty()

True if this element can be deleted interactively, false otherwise.

The value of InteractionConfiguration.allowDeletingSelectedElementProperty() of the current tool determines this value. The element can be deleted programmatically regardless of this value, for example using GeometryEditor.deleteSelectedElement().

A GeometryEditorMidVertex is not part of the geometry state, and therefore can never be deleted from the geometry regardless of the InteractionConfiguration settings.

Returns:

the canDelete property

Since:

200.1.0

See Also:

• getCanDelete()

getCanDelete

public boolean getCanDelete()

Gets the value of the canDelete property.

Property description:

True if this element can be deleted interactively, false otherwise.

The value of InteractionConfiguration.allowDeletingSelectedElementProperty() of the current tool determines this value. The element can be deleted programmatically regardless of this value, for example using GeometryEditor.deleteSelectedElement().

A GeometryEditorMidVertex is not part of the geometry state, and therefore can never be deleted from the geometry regardless of the InteractionConfiguration settings.

Returns:

the value of the canDelete property

Since:

200.1.0

See Also:

• canDeleteProperty()

canMoveProperty

public ReadOnlyBooleanProperty canMoveProperty()

True if this element can be moved interactively, false otherwise.

The value of the InteractionConfiguration.allowMovingSelectedElementProperty() of the current tool determines this value. The element can be moved programmatically regardless of this value, for example using GeometryEditor.moveSelectedElement(Point).

A GeometryEditorMidVertex is not part of the geometry state, and therefore can never be moved regardless of the InteractionConfiguration settings.

Returns:

the canMove property

Since:

200.1.0

See Also:

• getCanMove()

getCanMove

public boolean getCanMove()

Gets the value of the canMove property.

Property description:

True if this element can be moved interactively, false otherwise.

The value of the InteractionConfiguration.allowMovingSelectedElementProperty() of the current tool determines this value. The element can be moved programmatically regardless of this value, for example using GeometryEditor.moveSelectedElement(Point).

A GeometryEditorMidVertex is not part of the geometry state, and therefore can never be moved regardless of the InteractionConfiguration settings.

Returns:

the value of the canMove property

Since:

200.1.0

See Also:

• canMoveProperty()

canRotateProperty

public ReadOnlyBooleanProperty canRotateProperty()

True if this element can be rotated interactively, false otherwise.

The value of InteractionConfiguration.allowRotatingSelectedElementProperty() of the current GeometryEditor.toolProperty() determines this value. The element can be rotated programmatically regardless of this value, for example using GeometryEditor.rotateSelectedElement(double, Point).

The following can never be rotated interactively, regardless of the InteractionConfiguration settings:

• GeometryEditorVertex
• GeometryEditorMidVertex
• GeometryEditorGeometry when the geometry type is GeometryType.POINT.

Returns:

the canRotate property

Since:

200.2.0

See Also:

• getCanRotate()

getCanRotate

public boolean getCanRotate()

Gets the value of the canRotate property.

Property description:

True if this element can be rotated interactively, false otherwise.

The value of InteractionConfiguration.allowRotatingSelectedElementProperty() of the current GeometryEditor.toolProperty() determines this value. The element can be rotated programmatically regardless of this value, for example using GeometryEditor.rotateSelectedElement(double, Point).

The following can never be rotated interactively, regardless of the InteractionConfiguration settings:

• GeometryEditorVertex
• GeometryEditorMidVertex
• GeometryEditorGeometry when the geometry type is GeometryType.POINT.

Returns:

the value of the canRotate property

Since:

200.2.0

See Also:

• canRotateProperty()

canScaleProperty

public ReadOnlyBooleanProperty canScaleProperty()

True if this element can be scaled interactively, false otherwise.

The value of InteractionConfiguration.allowScalingSelectedElementProperty() of the current GeometryEditor.toolProperty() determines this value. The element can be scaled programmatically regardless of this value, for example using GeometryEditor.scaleSelectedElement(double, double, Point).

The following can never be scaled interactively, regardless of the InteractionConfiguration settings:

• GeometryEditorVertex
• GeometryEditorMidVertex
• GeometryEditorGeometry when the geometry type is GeometryType.POINT.

Returns:

the canScale property

Since:

200.2.0

See Also:

• getCanScale()

getCanScale

public boolean getCanScale()

Gets the value of the canScale property.

Property description:

True if this element can be scaled interactively, false otherwise.

The value of InteractionConfiguration.allowScalingSelectedElementProperty() of the current GeometryEditor.toolProperty() determines this value. The element can be scaled programmatically regardless of this value, for example using GeometryEditor.scaleSelectedElement(double, double, Point).

The following can never be scaled interactively, regardless of the InteractionConfiguration settings:

• GeometryEditorVertex
• GeometryEditorMidVertex
• GeometryEditorGeometry when the geometry type is GeometryType.POINT.

Returns:

the value of the canScale property

Since:

200.2.0

See Also:

• canScaleProperty()

extentProperty

public ReadOnlyObjectProperty<Envelope> extentProperty()

The extent of the selected element in the SpatialReference of the associated MapView.

To find the specific shape of the selected element instead of its extent, use the GeometryEditorGeometry.geometryProperty(), GeometryEditorMidVertex.pointProperty(), GeometryEditorPart.partProperty(), or GeometryEditorVertex.pointProperty().

Returns:

the extent property

Since:

200.1.0

See Also:

• getExtent()

getExtent

public Envelope getExtent()

Gets the value of the extent property.

Property description:

The extent of the selected element in the SpatialReference of the associated MapView.

To find the specific shape of the selected element instead of its extent, use the GeometryEditorGeometry.geometryProperty(), GeometryEditorMidVertex.pointProperty(), GeometryEditorPart.partProperty(), or GeometryEditorVertex.pointProperty().

Returns:

the value of the extent property

Since:

200.1.0

See Also:

• extentProperty()