Package com.esri.arcgisruntime.mapping.view

Class GeoView.InteractionOptions

java.lang.Object

com.esri.arcgisruntime.mapping.view.GeoView.InteractionOptions

Direct Known Subclasses:

MapView.InteractionOptions

Enclosing class:

GeoView

public abstract static class GeoView.InteractionOptions
extends java.lang.Object

Defines options to control user interactions with a GeoView.

Since:

100.9.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InteractionOptions(GeoView geoView)	Constructs an instance of InteractionOptions for GeoView.

Method Summary

Modifier and Type	Method	Description
double	getZoomFactor()	Gets the zoom factor which controls the zoom amount for zooming in via double-tap and zooming out via multi-pointer-tap gestures.
boolean	isEnabled()	Indicates whether user interactions on the GeoView are disabled or not.
boolean	isFlickEnabled()	Indicates whether the GeoView can be flicked with a fast pan gesture.
void	setEnabled(boolean enabled)	Sets whether or not user interactions on the GeoView are enabled.
void	setFlickEnabled(boolean flickEnabled)	Sets whether or not the GeoView can be flicked.
void	setZoomFactor(double zoomFactor)	Sets the zoom factor which controls the zoom amount for zooming in via double-tap and zooming out via multi-pointer-tap gestures.

Methods inherited from class java.lang.Object

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

Constructor Detail

InteractionOptions

protected InteractionOptions(GeoView geoView)

Constructs an instance of InteractionOptions for GeoView.

Parameters:

geoView - the GeoView to control

Throws:

java.lang.IllegalArgumentException - if geoView is null

Since:

100.9.0

Method Detail

isEnabled

public boolean isEnabled()

Indicates whether user interactions on the GeoView are disabled or not.

By default, the user interactions are enabled.

Returns:

true if user interactions are enabled, false otherwise

Since:

100.9.0

setEnabled

public void setEnabled(boolean enabled)

Sets whether or not user interactions on the GeoView are enabled.

If the property is set to false, the GeoView is "locked" from user interactions and can only be controlled using the GeoView.setViewpoint(com.esri.arcgisruntime.mapping.Viewpoint) or GeoView.setViewpointAsync(com.esri.arcgisruntime.mapping.Viewpoint) methods.

Parameters:

enabled - true to enable all user interactions, false otherwise

Since:

100.9.0

isFlickEnabled

public boolean isFlickEnabled()

Indicates whether the GeoView can be flicked with a fast pan gesture. The default is true.

Returns:

true if the GeoView can be flicked, false otherwise

Since:

100.9.0

setFlickEnabled

public void setFlickEnabled(boolean flickEnabled)

Sets whether or not the GeoView can be flicked. The default is true.

Parameters:

flickEnabled - true to enable flicking on the GeoView, false otherwise

Since:

100.9.0

setZoomFactor

public void setZoomFactor(double zoomFactor)

Sets the zoom factor which controls the zoom amount for zooming in via double-tap and zooming out via multi-pointer-tap gestures. The default value for MapView is 2.0.

The zoom factor should be equal to or greater than 1.0.

Parameters:

zoomFactor - the zoom amount for zooming interactions

Throws:

java.lang.IllegalArgumentException - if zoomFactor is not a valid number or less than 1.0

Since:

100.9.0

getZoomFactor

public double getZoomFactor()

Gets the zoom factor which controls the zoom amount for zooming in via double-tap and zooming out via multi-pointer-tap gestures. The default value for MapView is 2.0.

Returns:

the zoom amount for zooming interactions

Since:

100.9.0