IPhotoView (library 1.3.0 API)

All Known Implementing Classes:

PhotoView, PhotoViewAttacher
```
public interface IPhotoView
```

Field Summary

Fields
Modifier and Type Field and Description

static float DEFAULT_MAX_SCALE

static float DEFAULT_MID_SCALE

static float DEFAULT_MIN_SCALE

static int DEFAULT_ZOOM_DURATION

Fields
Modifier and Type	Field and Description
`static float`	`DEFAULT_MAX_SCALE`
`static float`	`DEFAULT_MID_SCALE`
`static float`	`DEFAULT_MIN_SCALE`
`static int`	`DEFAULT_ZOOM_DURATION`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`canZoom()` Returns true if the PhotoView is set to allow zooming of Photos.
`void`	`getDisplayMatrix(android.graphics.Matrix matrix)` Copies the Display Matrix of the currently displayed Drawable.
`android.graphics.RectF`	`getDisplayRect()` Gets the Display Rectangle of the currently displayed Drawable.
`IPhotoView`	`getIPhotoViewImplementation()` Will return instance of IPhotoView (eg.
`float`	`getMaximumScale()`
`float`	`getMediumScale()`
`float`	`getMinimumScale()`
`float`	`getScale()` Returns the current scale value
`android.widget.ImageView.ScaleType`	`getScaleType()` Return the current scale type in use by the ImageView.
`android.graphics.Bitmap`	`getVisibleRectangleBitmap()` Extracts currently visible area to Bitmap object, if there is no image loaded yet or the ImageView is already destroyed, returns `null`
`void`	`setAllowParentInterceptOnEdge(boolean allow)` Whether to allow the ImageView's parent to intercept the touch event when the photo is scroll to it's horizontal edge.
`boolean`	`setDisplayMatrix(android.graphics.Matrix finalMatrix)` Sets the Display Matrix of the currently displayed Drawable.
`void`	`setMaximumScale(float maximumScale)` Sets the maximum scale level.
`void`	`setMediumScale(float mediumScale)` Sets the medium scale level.
`void`	`setMinimumScale(float minimumScale)` Sets the minimum scale level.
`void`	`setOnDoubleTapListener(android.view.GestureDetector.OnDoubleTapListener newOnDoubleTapListener)` Sets custom double tap listener, to intercept default given functions.
`void`	`setOnLongClickListener(android.view.View.OnLongClickListener listener)` Register a callback to be invoked when the Photo displayed by this view is long-pressed.
`void`	`setOnMatrixChangeListener(PhotoViewAttacher.OnMatrixChangedListener listener)` Register a callback to be invoked when the Matrix has changed for this View.
`void`	`setOnPhotoTapListener(PhotoViewAttacher.OnPhotoTapListener listener)` Register a callback to be invoked when the Photo displayed by this View is tapped with a single tap.
`void`	`setOnScaleChangeListener(PhotoViewAttacher.OnScaleChangeListener onScaleChangeListener)` Will report back about scale changes
`void`	`setOnSingleFlingListener(PhotoViewAttacher.OnSingleFlingListener onSingleFlingListener)` Will report back about fling(single touch)
`void`	`setOnViewTapListener(PhotoViewAttacher.OnViewTapListener listener)` Register a callback to be invoked when the View is tapped with a single tap.
`void`	`setRotationBy(float rotationDegree)` Enables rotation via PhotoView internal functions.
`void`	`setRotationTo(float rotationDegree)` Enables rotation via PhotoView internal functions.
`void`	`setScale(float scale)` Changes the current scale to the specified value.
`void`	`setScale(float scale, boolean animate)` Changes the current scale to the specified value.
`void`	`setScale(float scale, float focalX, float focalY, boolean animate)` Changes the current scale to the specified value, around the given focal point.
`void`	`setScaleLevels(float minimumScale, float mediumScale, float maximumScale)` Allows to set all three scale levels at once, so you don't run into problem with setting medium/minimum scale before the maximum one
`void`	`setScaleType(android.widget.ImageView.ScaleType scaleType)` Controls how the image should be resized or moved to match the size of the ImageView.
`void`	`setZoomable(boolean zoomable)` Allows you to enable/disable the zoom functionality on the ImageView.
`void`	`setZoomTransitionDuration(int milliseconds)` Allows to change zoom transition speed, default value is 200 (PhotoViewAttacher.DEFAULT_ZOOM_DURATION).

- Field Detail
  - DEFAULT_MAX_SCALE
```
static final float DEFAULT_MAX_SCALE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MID_SCALE
```
static final float DEFAULT_MID_SCALE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MIN_SCALE
```
static final float DEFAULT_MIN_SCALE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ZOOM_DURATION
```
static final int DEFAULT_ZOOM_DURATION
```
    See Also:
    
    Constant Field Values
- Method Detail
  - canZoom
```
boolean canZoom()
```
    Returns true if the PhotoView is set to allow zooming of Photos.
    
    Returns:
    
    true if the PhotoView allows zooming.
  - getDisplayRect
```
android.graphics.RectF getDisplayRect()
```
    Gets the Display Rectangle of the currently displayed Drawable. The Rectangle is relative to this View and includes all scaling and translations.
    
    Returns:
    
    - RectF of Displayed Drawable
  - setDisplayMatrix
```
boolean setDisplayMatrix(android.graphics.Matrix finalMatrix)
```
    Sets the Display Matrix of the currently displayed Drawable. The Rectangle is considered relative to this View and includes all scaling and translations.
    
    Parameters:
    
    finalMatrix - target matrix to set PhotoView to
    
    Returns:
    
    - true if rectangle was applied successfully
  - getDisplayMatrix
```
void getDisplayMatrix(android.graphics.Matrix matrix)
```
    Copies the Display Matrix of the currently displayed Drawable. The Rectangle is considered relative to this View and includes all scaling and translations.
    
    Parameters:
    
    matrix - target matrix to copy to
  - getMinimumScale
```
float getMinimumScale()
```
    Returns:
    
    The current minimum scale level. What this value represents depends on the current ImageView.ScaleType.
  - getMediumScale
```
float getMediumScale()
```
    Returns:
    
    The current medium scale level. What this value represents depends on the current ImageView.ScaleType.
  - getMaximumScale
```
float getMaximumScale()
```
    Returns:
    
    The current maximum scale level. What this value represents depends on the current ImageView.ScaleType.
  - getScale
```
float getScale()
```
    Returns the current scale value
    
    Returns:
    
    float - current scale value
  - getScaleType
```
android.widget.ImageView.ScaleType getScaleType()
```
    Return the current scale type in use by the ImageView.
    
    Returns:
    
    current ImageView.ScaleType
  - setAllowParentInterceptOnEdge
```
void setAllowParentInterceptOnEdge(boolean allow)
```
    Whether to allow the ImageView's parent to intercept the touch event when the photo is scroll to it's horizontal edge.
    
    Parameters:
    
    allow - whether to allow intercepting by parent element or not
  - setMinimumScale
```
void setMinimumScale(float minimumScale)
```
    Sets the minimum scale level. What this value represents depends on the current ImageView.ScaleType.
    
    Parameters:
    
    minimumScale - minimum allowed scale
  - setMediumScale
```
void setMediumScale(float mediumScale)
```
    Sets the medium scale level. What this value represents depends on the current ImageView.ScaleType.
    
    Parameters:
    
    mediumScale - medium scale preset
  - setMaximumScale
```
void setMaximumScale(float maximumScale)
```
    Sets the maximum scale level. What this value represents depends on the current ImageView.ScaleType.
    
    Parameters:
    
    maximumScale - maximum allowed scale preset
  - setScaleLevels
```
void setScaleLevels(float minimumScale,
                    float mediumScale,
                    float maximumScale)
```
    Allows to set all three scale levels at once, so you don't run into problem with setting medium/minimum scale before the maximum one
    
    Parameters:
    
    minimumScale - minimum allowed scale
    
    mediumScale - medium allowed scale
    
    maximumScale - maximum allowed scale preset
  - setOnLongClickListener
```
void setOnLongClickListener(android.view.View.OnLongClickListener listener)
```
    Register a callback to be invoked when the Photo displayed by this view is long-pressed.
    
    Parameters:
    
    listener - - Listener to be registered.
  - setOnMatrixChangeListener
```
void setOnMatrixChangeListener(PhotoViewAttacher.OnMatrixChangedListener listener)
```
    Register a callback to be invoked when the Matrix has changed for this View. An example would be the user panning or scaling the Photo.
    
    Parameters:
    
    listener - - Listener to be registered.
  - setOnPhotoTapListener
```
void setOnPhotoTapListener(PhotoViewAttacher.OnPhotoTapListener listener)
```
    Register a callback to be invoked when the Photo displayed by this View is tapped with a single tap.
    
    Parameters:
    
    listener - - Listener to be registered.
  - setOnViewTapListener
```
void setOnViewTapListener(PhotoViewAttacher.OnViewTapListener listener)
```
    Register a callback to be invoked when the View is tapped with a single tap.
    
    Parameters:
    
    listener - - Listener to be registered.
  - setRotationTo
```
void setRotationTo(float rotationDegree)
```
    Enables rotation via PhotoView internal functions.
    
    Parameters:
    
    rotationDegree - - Degree to rotate PhotoView to, should be in range 0 to 360
  - setRotationBy
```
void setRotationBy(float rotationDegree)
```
    Enables rotation via PhotoView internal functions.
    
    Parameters:
    
    rotationDegree - - Degree to rotate PhotoView by, should be in range 0 to 360
  - setScale
```
void setScale(float scale)
```
    Changes the current scale to the specified value.
    
    Parameters:
    
    scale - - Value to scale to
  - setScale
```
void setScale(float scale,
              boolean animate)
```
    Changes the current scale to the specified value.
    
    Parameters:
    
    scale - - Value to scale to
    
    animate - - Whether to animate the scale
  - setScale
```
void setScale(float scale,
              float focalX,
              float focalY,
              boolean animate)
```
    Changes the current scale to the specified value, around the given focal point.
    
    Parameters:
    
    scale - - Value to scale to
    
    focalX - - X Focus Point
    
    focalY - - Y Focus Point
    
    animate - - Whether to animate the scale
  - setScaleType
```
void setScaleType(android.widget.ImageView.ScaleType scaleType)
```
    Controls how the image should be resized or moved to match the size of the ImageView. Any scaling or panning will happen within the confines of this ImageView.ScaleType.
    
    Parameters:
    
    scaleType - - The desired scaling mode.
  - setZoomable
```
void setZoomable(boolean zoomable)
```
    Allows you to enable/disable the zoom functionality on the ImageView. When disable the ImageView reverts to using the FIT_CENTER matrix.
    
    Parameters:
    
    zoomable - - Whether the zoom functionality is enabled.
  - getVisibleRectangleBitmap
```
android.graphics.Bitmap getVisibleRectangleBitmap()
```
    Extracts currently visible area to Bitmap object, if there is no image loaded yet or the ImageView is already destroyed, returns null
    
    Returns:
    
    currently visible area as bitmap or null
  - setZoomTransitionDuration
```
void setZoomTransitionDuration(int milliseconds)
```
    Allows to change zoom transition speed, default value is 200 (PhotoViewAttacher.DEFAULT_ZOOM_DURATION). Will default to 200 if provided negative value
    
    Parameters:
    
    milliseconds - duration of zoom interpolation
  - getIPhotoViewImplementation
```
IPhotoView getIPhotoViewImplementation()
```
    Will return instance of IPhotoView (eg. PhotoViewAttacher), can be used to provide better integration
    
    Returns:
    
    IPhotoView implementation instance if available, null if not
  - setOnDoubleTapListener
```
void setOnDoubleTapListener(android.view.GestureDetector.OnDoubleTapListener newOnDoubleTapListener)
```
    Sets custom double tap listener, to intercept default given functions. To reset behavior to default, you can just pass in "null" or public field of PhotoViewAttacher.defaultOnDoubleTapListener
    
    Parameters:
    
    newOnDoubleTapListener - custom OnDoubleTapListener to be set on ImageView
  - setOnScaleChangeListener
```
void setOnScaleChangeListener(PhotoViewAttacher.OnScaleChangeListener onScaleChangeListener)
```
    Will report back about scale changes
    
    Parameters:
    
    onScaleChangeListener - OnScaleChangeListener instance
  - setOnSingleFlingListener
```
void setOnSingleFlingListener(PhotoViewAttacher.OnSingleFlingListener onSingleFlingListener)
```
    Will report back about fling(single touch)
    
    Parameters:
    
    onSingleFlingListener - OnSingleFlingListener instance

Interface IPhotoView

Field Summary

Method Summary

Field Detail

DEFAULT_MAX_SCALE

DEFAULT_MID_SCALE

DEFAULT_MIN_SCALE

DEFAULT_ZOOM_DURATION

Method Detail

canZoom

getDisplayRect

setDisplayMatrix

getDisplayMatrix

getMinimumScale

getMediumScale

getMaximumScale

getScale

getScaleType

setAllowParentInterceptOnEdge

setMinimumScale

setMediumScale

setMaximumScale

setScaleLevels

setOnLongClickListener

setOnMatrixChangeListener

setOnPhotoTapListener

setOnViewTapListener

setRotationTo

setRotationBy

setScale

setScale

setScale

setScaleType

setZoomable

getVisibleRectangleBitmap

setZoomTransitionDuration

getIPhotoViewImplementation

setOnDoubleTapListener

setOnScaleChangeListener

setOnSingleFlingListener