Module com.esri.arcgisruntime

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

Class SnapSourceSettings

java.lang.Object

com.esri.arcgisruntime.mapping.view.geometryeditor.SnapSourceSettings

public final class SnapSourceSettings
extends Object

Configures a valid source of geometries that the GeometryEditor can snap interactive edits to.

Following a call to SnapSettings.syncSourceSettings(), the SnapSettings.getSourceSettings() collection is populated with SnapSourceSettings objects that are valid for snapping. Each represents a SnapSource that is in the currently connected map and provides full resolution geometries suitable for snapping.

Set enabledProperty() to true for each item that you want to allow your users to snap to. You may wish to delegate the choice of snapping sources to users by binding the collection of snapping sources to controls which allow them to change SnapSourceSettings.enabledProperty() for each snapping source individually.

Snapping works for visible objects within the SnapSource - for example if a layer is not visible due to the current scale range, definition expression, or other reason, it will not participate in snapping at that time. Visibility does not affect whether a SnapSourceSettings object is present in the SnapSettings.getSourceSettings() collection or not.

See SnapSource for more information about which data sources are valid for snapping.

Since:

200.4.0

See Also:

• SnapSettings
• SnapSource

Property Summary

Properties

Type	Property	Description
BooleanProperty	enabled	True to enable snapping to the geometries in the SnapSource, false otherwise.
ReadOnlyObjectProperty<SnapSource>	source	Underlying source of geometries to snap to, for example a FeatureLayer.

Method Summary

Modifier and Type	Method	Description
BooleanProperty	enabledProperty()	True to enable snapping to the geometries in the SnapSource, false otherwise.
SnapSource	getSource()	Gets the value of the source property.
boolean	isEnabled()	Gets the value of the enabled property.
void	setEnabled(boolean isEnabled)	Sets the value of the enabled property.
ReadOnlyObjectProperty<SnapSource>	sourceProperty()	Underlying source of geometries to snap to, for example a FeatureLayer.

Methods inherited from class java.lang.Object

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

Property Details

enabled

public BooleanProperty enabledProperty

True to enable snapping to the geometries in the SnapSource, false otherwise. Default is false.

Snapping sources can be enabled or disabled individually. If SnapSettings.enabledProperty() is false, this value is ignored and snapping is not enabled.

Since:

200.4.0

See Also:

• isEnabled()
• setEnabled(boolean)
• enabledProperty()

source

public ReadOnlyObjectProperty<SnapSource> sourceProperty

Underlying source of geometries to snap to, for example a FeatureLayer.

Since:

200.4.0

See Also:

• getSource()
• sourceProperty()

Method Details

enabledProperty

public BooleanProperty enabledProperty()

True to enable snapping to the geometries in the SnapSource, false otherwise. Default is false.

Snapping sources can be enabled or disabled individually. If SnapSettings.enabledProperty() is false, this value is ignored and snapping is not enabled.

Returns:

the enabled property

Since:

200.4.0

See Also:

• isEnabled()
• setEnabled(boolean)

isEnabled

public boolean isEnabled()

Gets the value of the enabled property.

Property description:

True to enable snapping to the geometries in the SnapSource, false otherwise. Default is false.

Snapping sources can be enabled or disabled individually. If SnapSettings.enabledProperty() is false, this value is ignored and snapping is not enabled.

Returns:

the value of the enabled property

Since:

200.4.0

See Also:

• setEnabled(boolean)
• enabledProperty()

setEnabled

public void setEnabled(boolean isEnabled)

Sets the value of the enabled property.

Property description:

True to enable snapping to the geometries in the SnapSource, false otherwise. Default is false.

Snapping sources can be enabled or disabled individually. If SnapSettings.enabledProperty() is false, this value is ignored and snapping is not enabled.

Parameters:

isEnabled - the value for the enabled property

Since:

200.4.0

See Also:

• isEnabled()
• enabledProperty()

sourceProperty

public ReadOnlyObjectProperty<SnapSource> sourceProperty()

Underlying source of geometries to snap to, for example a FeatureLayer.

Returns:

the source property

Since:

200.4.0

See Also:

• getSource()

getSource

public SnapSource getSource()

Gets the value of the source property.

Property description:

Underlying source of geometries to snap to, for example a FeatureLayer.

Returns:

the value of the source property

Since:

200.4.0

See Also:

• sourceProperty()