Settings (GestureViews 2.8.2 API)

java.lang.Object
- com.alexvasilkov.gestures.Settings

```
public class Settings
extends java.lang.Object
```
Various settings needed for GestureController and for StateController.
Required settings are viewport size (setViewport(int, int)) and image size setImage(int, int)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Settings.Bounds

static class Settings.ExitType

static class Settings.Fit

Nested Classes
Modifier and Type	Class and Description
`static class`	`Settings.Bounds`
`static class`	`Settings.ExitType`
`static class`	`Settings.Fit`

Field Summary

Fields
Modifier and Type Field and Description

static long ANIMATIONS_DURATION

static float MAX_ZOOM

static float OVERZOOM_FACTOR

Fields
Modifier and Type	Field and Description
`static long`	`ANIMATIONS_DURATION`
`static float`	`MAX_ZOOM`
`static float`	`OVERZOOM_FACTOR`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Settings`	`disableBounds()` Disable bounds restrictions. Calls to this method are counted, so if you called it N times you should call `enableBounds()` N times to re-enable bounds restrictions.
`Settings`	`disableGestures()` Disable all gestures. Calls to this method are counted, so if you called it N times you should call `enableGestures()` N times to re-enable all gestures.
`Settings`	`enableBounds()` Re-enable bounds restrictions disabled by `disableBounds()` method. Calls to this method are counted, so if you called `disableBounds()` N times you should call this method N times to re-enable bounds restrictions.
`Settings`	`enableGestures()` Re-enable all gestures disabled by `disableGestures()` method. Calls to this method are counted, so if you called `disableGestures()` N times you should call this method N times to re-enable all gestures.
`long`	`getAnimationsDuration()`
`Settings.Bounds`	`getBoundsType()`
`float`	`getDoubleTapZoom()`
`Settings.ExitType`	`getExitType()`
`Settings.Fit`	`getFitMethod()`
`int`	`getGravity()`
`int`	`getImageH()`
`int`	`getImageW()`
`float`	`getMaxZoom()`
`float`	`getMinZoom()`
`int`	`getMovementAreaH()`
`int`	`getMovementAreaW()`
`float`	`getOverscrollDistanceX()`
`float`	`getOverscrollDistanceY()`
`float`	`getOverzoomFactor()`
`int`	`getViewportH()`
`int`	`getViewportW()`
`boolean`	`hasImageSize()`
`boolean`	`hasViewportSize()`
`void`	`initFromAttributes(android.content.Context context, android.util.AttributeSet attrs)`
`boolean`	`isDoubleTapEnabled()`
`boolean`	`isEnabled()`
`boolean`	`isExitEnabled()`
`boolean`	`isFillViewport()`
`boolean`	`isFlingEnabled()`
`boolean`	`isGesturesEnabled()`
`boolean`	`isPanEnabled()`
`boolean`	`isRestrictBounds()`
`boolean`	`isRestrictRotation()`
`boolean`	`isRotationEnabled()`
`boolean`	`isZoomEnabled()`
`Settings`	`setAnimationsDuration(long duration)` Duration of animations.
`Settings`	`setBoundsType(Settings.Bounds boundsType)` Setting movement bounds restriction type.
`Settings`	`setDoubleTapEnabled(boolean enabled)` Sets whether zooming by double tap is enabled or not.
`Settings`	`setDoubleTapZoom(float doubleTapZoom)` Setting double tap zoom level, should not be greater than `getMaxZoom()`.
`Settings`	`setExitEnabled(boolean enabled)` Sets whether to detect and animate exit from gesture views.
`Settings`	`setExitType(Settings.ExitType type)` Sets which gestures to use to detect exit.
`Settings`	`setFillViewport(boolean isFitViewport)` If set to true small images will be scaled to fit entire viewport (or entire movement area if it was set) even if this will require zoom level above max zoom level.
`Settings`	`setFitMethod(Settings.Fit fitMethod)` Setting image fitting method within viewport area.
`Settings`	`setFlingEnabled(boolean enabled)` Sets whether fling (inertial motion after scroll) is enabled or not.
`Settings`	`setGravity(int gravity)` Setting image gravity inside viewport area.
`Settings`	`setImage(int width, int height)` Setting full image size.
`Settings`	`setMaxZoom(float maxZoom)` Setting max zoom level.
`Settings`	`setMinZoom(float minZoom)` Setting min zoom level.
`Settings`	`setMovementArea(int width, int height)` Setting movement area size.
`Settings`	`setOverscrollDistance(android.content.Context context, float distanceXDp, float distanceYDp)` Same as `setOverscrollDistance(float, float)` but accepts distance in DP.
`Settings`	`setOverscrollDistance(float distanceX, float distanceY)` Setting overscroll distance in pixels.
`Settings`	`setOverzoomFactor(float factor)` Setting overzoom factor.
`Settings`	`setPanEnabled(boolean enabled)` Sets whether panning is enabled or not.
`Settings`	`setRestrictRotation(boolean restrict)` Sets whether image rotation should stick to 90 degrees intervals or can be free.
`Settings`	`setRotationEnabled(boolean enabled)` Sets whether rotation gesture is enabled or not.
`Settings`	`setViewport(int width, int height)` Setting viewport size.
`Settings`	`setZoomEnabled(boolean enabled)` Sets whether zooming is enabled or not.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MAX_ZOOM
```
public static final float MAX_ZOOM
```
    See Also:
    
    Constant Field Values
  - OVERZOOM_FACTOR
```
public static final float OVERZOOM_FACTOR
```
    See Also:
    
    Constant Field Values
  - ANIMATIONS_DURATION
```
public static final long ANIMATIONS_DURATION
```
    See Also:
    
    Constant Field Values
- Method Detail
  - initFromAttributes
```
public void initFromAttributes(@NonNull
                               android.content.Context context,
                               @Nullable
                               android.util.AttributeSet attrs)
```
  - setViewport
```
@NonNull
public Settings setViewport(int width,
                                     int height)
```
    Setting viewport size.
    Should only be used when implementing custom GestureView.
    
    Parameters:
    
    width - Viewport width
    
    height - Viewport height
    
    Returns:
    
    Current settings object for calls chaining
  - setMovementArea
```
@NonNull
public Settings setMovementArea(int width,
                                         int height)
```
    Setting movement area size. Viewport area will be used instead if no movement area is specified.
    
    Parameters:
    
    width - Movement area width
    
    height - Movement area height
    
    Returns:
    
    Current settings object for calls chaining
  - setImage
```
@NonNull
public Settings setImage(int width,
                                  int height)
```
    Setting full image size.
    Should only be used when implementing custom GestureView.
    
    Parameters:
    
    width - Image width
    
    height - Image height
    
    Returns:
    
    Current settings object for calls chaining
  - setMinZoom
```
@NonNull
public Settings setMinZoom(float minZoom)
```
    Setting min zoom level.
    Default value is 0.
    
    Parameters:
    
    minZoom - Min zoom level, or 0 to use zoom level which fits the image into the viewport.
    
    Returns:
    
    Current settings object for calls chaining
  - setMaxZoom
```
@NonNull
public Settings setMaxZoom(float maxZoom)
```
    Setting max zoom level.
    Default value is MAX_ZOOM.
    
    Parameters:
    
    maxZoom - Max zoom level, or 0 to use zoom level which fits the image into the viewport.
    
    Returns:
    
    Current settings object for calls chaining
  - setDoubleTapZoom
```
@NonNull
public Settings setDoubleTapZoom(float doubleTapZoom)
```
    Setting double tap zoom level, should not be greater than getMaxZoom(). Defaults to getMaxZoom() if <= 0.
    Default value is -1.
    
    Parameters:
    
    doubleTapZoom - Double tap zoom level
    
    Returns:
    
    Current settings object for calls chaining
  - setOverzoomFactor
```
@NonNull
public Settings setOverzoomFactor(float factor)
```
    Setting overzoom factor. User will be able to "over zoom" up to this factor. Cannot be < 1.
    Default value is OVERZOOM_FACTOR.
    
    Parameters:
    
    factor - Overzoom factor
    
    Returns:
    
    Current settings object for calls chaining
  - setOverscrollDistance
```
@NonNull
public Settings setOverscrollDistance(float distanceX,
                                               float distanceY)
```
    Setting overscroll distance in pixels. User will be able to "over scroll" up to this distance. Cannot be < 0.
    Default value is 0.
    
    Parameters:
    
    distanceX - Horizontal overscroll distance in pixels
    
    distanceY - Vertical overscroll distance in pixels
    
    Returns:
    
    Current settings object for calls chaining
  - setOverscrollDistance
```
@NonNull
public Settings setOverscrollDistance(@NonNull
                                               android.content.Context context,
                                               float distanceXDp,
                                               float distanceYDp)
```
    Same as setOverscrollDistance(float, float) but accepts distance in DP.
    
    Parameters:
    
    context - Context
    
    distanceXDp - Horizontal overscroll distance in dp
    
    distanceYDp - Vertical overscroll distance in dp
    
    Returns:
    
    Current settings object for calls chaining
  - setFillViewport
```
@NonNull
public Settings setFillViewport(boolean isFitViewport)
```
    If set to true small images will be scaled to fit entire viewport (or entire movement area if it was set) even if this will require zoom level above max zoom level. And big images will be scaled to fit the viewport even if it will require zooming below min zoom.
    Default value is false.
    
    Parameters:
    
    isFitViewport - Whether image should fit viewport or not
    
    Returns:
    
    Current settings object for calls chaining
  - setGravity
```
@NonNull
public Settings setGravity(int gravity)
```
    Setting image gravity inside viewport area.
    Default value is Gravity.CENTER.
    
    Parameters:
    
    gravity - Image gravity, one of Gravity constants
    
    Returns:
    
    Current settings object for calls chaining
  - setFitMethod
```
@NonNull
public Settings setFitMethod(@NonNull
                                      Settings.Fit fitMethod)
```
    Setting image fitting method within viewport area.
    Default value is Settings.Fit.INSIDE.
    
    Parameters:
    
    fitMethod - Fit method
    
    Returns:
    
    Current settings object for calls chaining
  - setBoundsType
```
@NonNull
public Settings setBoundsType(@NonNull
                                       Settings.Bounds boundsType)
```
    Setting movement bounds restriction type.
    Default value is Settings.Bounds.NORMAL.
    
    Parameters:
    
    boundsType - Bounds restrictions type
    
    Returns:
    
    Current settings object for calls chaining
  - setPanEnabled
```
@NonNull
public Settings setPanEnabled(boolean enabled)
```
    Sets whether panning is enabled or not.
    Default value is true.
    
    Parameters:
    
    enabled - Whether panning should be enabled or not
    
    Returns:
    
    Current settings object for calls chaining
  - setFlingEnabled
```
@NonNull
public Settings setFlingEnabled(boolean enabled)
```
    Sets whether fling (inertial motion after scroll) is enabled or not.
    Default value is true.
    
    Parameters:
    
    enabled - Whether fling should be enabled or not
    
    Returns:
    
    Current settings object for calls chaining
  - setZoomEnabled
```
@NonNull
public Settings setZoomEnabled(boolean enabled)
```
    Sets whether zooming is enabled or not.
    Default value is true.
    
    Parameters:
    
    enabled - Whether zooming should be enabled or not
    
    Returns:
    
    Current settings object for calls chaining
  - setRotationEnabled
```
@NonNull
public Settings setRotationEnabled(boolean enabled)
```
    Sets whether rotation gesture is enabled or not.
    Default value is false.
    
    Parameters:
    
    enabled - Whether rotation should be enabled or not
    
    Returns:
    
    Current settings object for calls chaining
  - setRestrictRotation
```
@NonNull
public Settings setRestrictRotation(boolean restrict)
```
    Sets whether image rotation should stick to 90 degrees intervals or can be free. Only applied when isRestrictBounds() is true as well.
    Default value is false.
    
    Parameters:
    
    restrict - Whether rotation should be restricted or not
    
    Returns:
    
    Current settings object for calls chaining
  - setDoubleTapEnabled
```
@NonNull
public Settings setDoubleTapEnabled(boolean enabled)
```
    Sets whether zooming by double tap is enabled or not.
    Default value is true.
    
    Parameters:
    
    enabled - Whether double tap should be enabled or not
    
    Returns:
    
    Current settings object for calls chaining
  - setExitEnabled
```
@NonNull
public Settings setExitEnabled(boolean enabled)
```
    Sets whether to detect and animate exit from gesture views.
    Default value is true.
    
    Parameters:
    
    enabled - Whether exit gesture should be enabled or not
    
    Returns:
    
    Current settings object for calls chaining
  - setExitType
```
@NonNull
public Settings setExitType(@NonNull
                                     Settings.ExitType type)
```
    Sets which gestures to use to detect exit.
    Default value is Settings.ExitType.ALL.
    
    Parameters:
    
    type - Exit type
    
    Returns:
    
    Current settings object for calls chaining
  - disableGestures
```
@NonNull
public Settings disableGestures()
```
    Disable all gestures.
    Calls to this method are counted, so if you called it N times you should call enableGestures() N times to re-enable all gestures.
    Useful when you need to temporary disable touch gestures during animation or image loading.
    See also enableGestures()
    
    Returns:
    
    Current settings object for calls chaining
  - enableGestures
```
@NonNull
public Settings enableGestures()
```
    Re-enable all gestures disabled by disableGestures() method.
    Calls to this method are counted, so if you called disableGestures() N times you should call this method N times to re-enable all gestures.
    See also disableGestures()
    
    Returns:
    
    Current settings object for calls chaining
  - disableBounds
```
@NonNull
public Settings disableBounds()
```
    Disable bounds restrictions.
    Calls to this method are counted, so if you called it N times you should call enableBounds() N times to re-enable bounds restrictions.
    Useful when you need to temporary disable bounds restrictions during animation.
    See also enableBounds()
    
    Returns:
    
    Current settings object for calls chaining
  - enableBounds
```
@NonNull
public Settings enableBounds()
```
    Re-enable bounds restrictions disabled by disableBounds() method.
    Calls to this method are counted, so if you called disableBounds() N times you should call this method N times to re-enable bounds restrictions.
    See also disableBounds()
    
    Returns:
    
    Current settings object for calls chaining
  - setAnimationsDuration
```
@NonNull
public Settings setAnimationsDuration(long duration)
```
    Duration of animations.
    
    Parameters:
    
    duration - Animation duration in milliseconds
    
    Returns:
    
    Current settings object for calls chaining
  - getViewportW
```
public int getViewportW()
```
  - getViewportH
```
public int getViewportH()
```
  - getMovementAreaW
```
public int getMovementAreaW()
```
  - getMovementAreaH
```
public int getMovementAreaH()
```
  - getImageW
```
public int getImageW()
```
  - getImageH
```
public int getImageH()
```
  - getMinZoom
```
public float getMinZoom()
```
  - getMaxZoom
```
public float getMaxZoom()
```
  - getDoubleTapZoom
```
public float getDoubleTapZoom()
```
  - getOverzoomFactor
```
public float getOverzoomFactor()
```
  - getOverscrollDistanceX
```
public float getOverscrollDistanceX()
```
  - getOverscrollDistanceY
```
public float getOverscrollDistanceY()
```
  - isFillViewport
```
public boolean isFillViewport()
```
  - getGravity
```
public int getGravity()
```
  - getFitMethod
```
@NonNull
public Settings.Fit getFitMethod()
```
  - getBoundsType
```
@NonNull
public Settings.Bounds getBoundsType()
```
  - isPanEnabled
```
public boolean isPanEnabled()
```
  - isFlingEnabled
```
public boolean isFlingEnabled()
```
  - isZoomEnabled
```
public boolean isZoomEnabled()
```
  - isRotationEnabled
```
public boolean isRotationEnabled()
```
  - isRestrictRotation
```
public boolean isRestrictRotation()
```
  - isDoubleTapEnabled
```
public boolean isDoubleTapEnabled()
```
  - isExitEnabled
```
public boolean isExitEnabled()
```
  - getExitType
```
@NonNull
public Settings.ExitType getExitType()
```
  - isGesturesEnabled
```
public boolean isGesturesEnabled()
```
  - isRestrictBounds
```
public boolean isRestrictBounds()
```
  - getAnimationsDuration
```
public long getAnimationsDuration()
```
  - isEnabled
```
public boolean isEnabled()
```
    Returns:
    
    Whether at least one of pan, zoom, rotation or double tap are enabled or not
  - hasImageSize
```
public boolean hasImageSize()
```
  - hasViewportSize
```
public boolean hasViewportSize()
```

Class Settings

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_ZOOM

OVERZOOM_FACTOR

ANIMATIONS_DURATION

Method Detail

initFromAttributes

setViewport

setMovementArea

setImage

setMinZoom

setMaxZoom

setDoubleTapZoom

setOverzoomFactor

setOverscrollDistance

setOverscrollDistance

setFillViewport

setGravity

setFitMethod

setBoundsType

setPanEnabled

setFlingEnabled

setZoomEnabled

setRotationEnabled

setRestrictRotation

setDoubleTapEnabled

setExitEnabled

setExitType

disableGestures

enableGestures

disableBounds

enableBounds

setAnimationsDuration

getViewportW

getViewportH

getMovementAreaW

getMovementAreaH

getImageW

getImageH

getMinZoom

getMaxZoom

getDoubleTapZoom

getOverzoomFactor

getOverscrollDistanceX

getOverscrollDistanceY

isFillViewport

getGravity

getFitMethod

getBoundsType

isPanEnabled

isFlingEnabled

isZoomEnabled

isRotationEnabled

isRestrictRotation

isDoubleTapEnabled

isExitEnabled

getExitType

isGesturesEnabled

isRestrictBounds

getAnimationsDuration

isEnabled

hasImageSize

hasViewportSize