uk.co.senab.photoview

Class PhotoViewAttacher

java.lang.Object

uk.co.senab.photoview.PhotoViewAttacher

All Implemented Interfaces:

android.view.View.OnTouchListener, android.view.ViewTreeObserver.OnGlobalLayoutListener, OnGestureListener, IPhotoView

public class PhotoViewAttacher
extends java.lang.Object
implements IPhotoView, android.view.View.OnTouchListener, OnGestureListener, android.view.ViewTreeObserver.OnGlobalLayoutListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PhotoViewAttacher.OnMatrixChangedListener Interface definition for a callback to be invoked when the internal Matrix has changed for this View.
static interface	PhotoViewAttacher.OnPhotoTapListener Interface definition for a callback to be invoked when the Photo is tapped with a single tap.
static interface	PhotoViewAttacher.OnScaleChangeListener Interface definition for callback to be invoked when attached ImageView scale changes
static interface	PhotoViewAttacher.OnViewTapListener Interface definition for a callback to be invoked when the ImageView is tapped with a single tap.

Field Summary

Fields inherited from interface uk.co.senab.photoview.IPhotoView

DEFAULT_MAX_SCALE, DEFAULT_MID_SCALE, DEFAULT_MIN_SCALE, DEFAULT_ZOOM_DURATION

Constructor Summary

Constructors

Constructor and Description
PhotoViewAttacher(android.widget.ImageView imageView)
PhotoViewAttacher(android.widget.ImageView imageView, boolean zoomable)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canZoom() Returns true if the PhotoView is set to allow zooming of Photos.
void	cleanup() Clean-up the resources attached to this object.
android.graphics.Matrix	getDisplayMatrix() Gets the Display Matrix of the currently displayed Drawable.
android.graphics.RectF	getDisplayRect() Gets the Display Rectangle of the currently displayed Drawable.
android.graphics.Matrix	getDrawMatrix()
android.widget.ImageView	getImageView()
IPhotoView	getIPhotoViewImplementation() Will return instance of IPhotoView (eg.
float	getMaximumScale()
float	getMaxScale() Deprecated.
float	getMediumScale()
float	getMidScale() Deprecated.
float	getMinimumScale()
float	getMinScale() Deprecated.
PhotoViewAttacher.OnPhotoTapListener	getOnPhotoTapListener() Returns a listener to be invoked when the Photo displayed by this View is tapped with a single tap.
PhotoViewAttacher.OnViewTapListener	getOnViewTapListener() Returns a callback listener to be invoked when the View is tapped with a single tap.
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	onDrag(float dx, float dy)
void	onFling(float startX, float startY, float velocityX, float velocityY)
void	onGlobalLayout()
void	onScale(float scaleFactor, float focusX, float focusY)
boolean	onTouch(android.view.View v, android.view.MotionEvent ev)
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	setMaxScale(float maxScale) Deprecated.
void	setMediumScale(float mediumScale)
void	setMidScale(float midScale) Deprecated.
void	setMinimumScale(float minimumScale) Sets the minimum scale level.
void	setMinScale(float minScale) Deprecated.
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	setOnViewTapListener(PhotoViewAttacher.OnViewTapListener listener) Register a callback to be invoked when the View is tapped with a single tap.
void	setPhotoViewRotation(float degrees) Deprecated. use setRotationTo(float)
void	setRotationBy(float degrees) Enables rotation via PhotoView internal functions.
void	setRotationTo(float degrees) 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).
void	update()

Methods inherited from class java.lang.Object

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

Constructor Detail

PhotoViewAttacher

public PhotoViewAttacher(android.widget.ImageView imageView)

PhotoViewAttacher

public PhotoViewAttacher(android.widget.ImageView imageView,
                 boolean zoomable)

Method Detail

setOnDoubleTapListener

public void setOnDoubleTapListener(android.view.GestureDetector.OnDoubleTapListener newOnDoubleTapListener)

Description copied from interface: IPhotoView

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

Specified by:

setOnDoubleTapListener in interface IPhotoView

Parameters:

newOnDoubleTapListener - custom OnDoubleTapListener to be set on ImageView

setOnScaleChangeListener

public void setOnScaleChangeListener(PhotoViewAttacher.OnScaleChangeListener onScaleChangeListener)

Description copied from interface: IPhotoView

Will report back about scale changes

Specified by:

setOnScaleChangeListener in interface IPhotoView

Parameters:

onScaleChangeListener - OnScaleChangeListener instance

canZoom

public boolean canZoom()

Description copied from interface: IPhotoView

Returns true if the PhotoView is set to allow zooming of Photos.

Specified by:

canZoom in interface IPhotoView

Returns:

true if the PhotoView allows zooming.

cleanup

public void cleanup()

Clean-up the resources attached to this object. This needs to be called when the ImageView is no longer used. A good example is from View.onDetachedFromWindow() or from android.app.Activity#onDestroy(). This is automatically called if you are using PhotoView.

getDisplayRect

public android.graphics.RectF getDisplayRect()

Description copied from interface: IPhotoView

Gets the Display Rectangle of the currently displayed Drawable. The Rectangle is relative to this View and includes all scaling and translations.

Specified by:

getDisplayRect in interface IPhotoView

Returns:

- RectF of Displayed Drawable

setDisplayMatrix

public boolean setDisplayMatrix(android.graphics.Matrix finalMatrix)

Description copied from interface: IPhotoView

Sets the Display Matrix of the currently displayed Drawable. The Rectangle is considered relative to this View and includes all scaling and translations.

Specified by:

setDisplayMatrix in interface IPhotoView

Parameters:

finalMatrix - target matrix to set PhotoView to

Returns:

- true if rectangle was applied successfully

setPhotoViewRotation

public void setPhotoViewRotation(float degrees)

Deprecated. use setRotationTo(float)

Description copied from interface: IPhotoView

Enables rotation via PhotoView internal functions. Name is chosen so it won't collide with View.setRotation(float) in API since 11

Specified by:

setPhotoViewRotation in interface IPhotoView

Parameters:

degrees - - Degree to rotate PhotoView to, should be in range 0 to 360

setRotationTo

public void setRotationTo(float degrees)

Description copied from interface: IPhotoView

Enables rotation via PhotoView internal functions.

Specified by:

setRotationTo in interface IPhotoView

Parameters:

degrees - - Degree to rotate PhotoView to, should be in range 0 to 360

setRotationBy

public void setRotationBy(float degrees)

Description copied from interface: IPhotoView

Enables rotation via PhotoView internal functions.

Specified by:

setRotationBy in interface IPhotoView

Parameters:

degrees - - Degree to rotate PhotoView by, should be in range 0 to 360

getImageView

public android.widget.ImageView getImageView()

getMinScale

@Deprecated
public float getMinScale()

Deprecated.

Description copied from interface: IPhotoView

Use IPhotoView.getMinimumScale() instead, this will be removed in future release

Specified by:

getMinScale in interface IPhotoView

Returns:

The current minimum scale level. What this value represents depends on the current ImageView.ScaleType.

getMinimumScale

public float getMinimumScale()

Specified by:

getMinimumScale in interface IPhotoView

Returns:

The current minimum scale level. What this value represents depends on the current ImageView.ScaleType.

getMidScale

@Deprecated
public float getMidScale()

Deprecated.

Description copied from interface: IPhotoView

Use IPhotoView.getMediumScale() instead, this will be removed in future release

Specified by:

getMidScale in interface IPhotoView

Returns:

The current middle scale level. What this value represents depends on the current ImageView.ScaleType.

getMediumScale

public float getMediumScale()

Specified by:

getMediumScale in interface IPhotoView

Returns:

The current medium scale level. What this value represents depends on the current ImageView.ScaleType.

getMaxScale

@Deprecated
public float getMaxScale()

Deprecated.

Description copied from interface: IPhotoView

Use IPhotoView.getMaximumScale() instead, this will be removed in future release

Specified by:

getMaxScale in interface IPhotoView

Returns:

The current maximum scale level. What this value represents depends on the current ImageView.ScaleType.

getMaximumScale

public float getMaximumScale()

Specified by:

getMaximumScale in interface IPhotoView

Returns:

The current maximum scale level. What this value represents depends on the current ImageView.ScaleType.

getScale

public float getScale()

Description copied from interface: IPhotoView

Returns the current scale value

Specified by:

getScale in interface IPhotoView

Returns:

float - current scale value

getScaleType

public android.widget.ImageView.ScaleType getScaleType()

Description copied from interface: IPhotoView

Return the current scale type in use by the ImageView.

Specified by:

getScaleType in interface IPhotoView

Returns:

current ImageView.ScaleType

onDrag

public void onDrag(float dx,
          float dy)

Specified by:

onDrag in interface OnGestureListener

onFling

public void onFling(float startX,
           float startY,
           float velocityX,
           float velocityY)

Specified by:

onFling in interface OnGestureListener

onGlobalLayout

public void onGlobalLayout()

Specified by:

onGlobalLayout in interface android.view.ViewTreeObserver.OnGlobalLayoutListener

onScale

public void onScale(float scaleFactor,
           float focusX,
           float focusY)

Specified by:

onScale in interface OnGestureListener

onTouch

public boolean onTouch(android.view.View v,
              android.view.MotionEvent ev)

Specified by:

onTouch in interface android.view.View.OnTouchListener

setAllowParentInterceptOnEdge

public void setAllowParentInterceptOnEdge(boolean allow)

Description copied from interface: IPhotoView

Whether to allow the ImageView's parent to intercept the touch event when the photo is scroll to it's horizontal edge.

Specified by:

setAllowParentInterceptOnEdge in interface IPhotoView

Parameters:

allow - whether to allow intercepting by parent element or not

setMinScale

@Deprecated
public void setMinScale(float minScale)

Deprecated.

Description copied from interface: IPhotoView

Use IPhotoView.setMinimumScale(float minimumScale) instead, this will be removed in future release

Sets the minimum scale level. What this value represents depends on the current ImageView.ScaleType.

Specified by:

setMinScale in interface IPhotoView

Parameters:

minScale - minimum allowed scale

setMinimumScale

public void setMinimumScale(float minimumScale)

Description copied from interface: IPhotoView

Sets the minimum scale level. What this value represents depends on the current ImageView.ScaleType.

Specified by:

setMinimumScale in interface IPhotoView

Parameters:

minimumScale - minimum allowed scale

setMidScale

@Deprecated
public void setMidScale(float midScale)

Deprecated.

Description copied from interface: IPhotoView

Use IPhotoView.setMediumScale(float mediumScale) instead, this will be removed in future release

Sets the middle scale level. What this value represents depends on the current ImageView.ScaleType.

Specified by:

setMidScale in interface IPhotoView

Parameters:

midScale - medium scale preset

setMediumScale

public void setMediumScale(float mediumScale)

Specified by:

setMediumScale in interface IPhotoView

setMaxScale

@Deprecated
public void setMaxScale(float maxScale)

Deprecated.

Description copied from interface: IPhotoView

Use IPhotoView.setMaximumScale(float maximumScale) instead, this will be removed in future release

Sets the maximum scale level. What this value represents depends on the current ImageView.ScaleType.

Specified by:

setMaxScale in interface IPhotoView

Parameters:

maxScale - maximum allowed scale preset

setMaximumScale

public void setMaximumScale(float maximumScale)

Description copied from interface: IPhotoView

Sets the maximum scale level. What this value represents depends on the current ImageView.ScaleType.

Specified by:

setMaximumScale in interface IPhotoView

Parameters:

maximumScale - maximum allowed scale preset

setScaleLevels

public void setScaleLevels(float minimumScale,
                  float mediumScale,
                  float maximumScale)

Description copied from interface: IPhotoView

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

Specified by:

setScaleLevels in interface IPhotoView

Parameters:

minimumScale - minimum allowed scale

mediumScale - medium allowed scale

maximumScale - maximum allowed scale preset

setOnLongClickListener

public void setOnLongClickListener(android.view.View.OnLongClickListener listener)

Description copied from interface: IPhotoView

Register a callback to be invoked when the Photo displayed by this view is long-pressed.

Specified by:

setOnLongClickListener in interface IPhotoView

Parameters:

listener - - Listener to be registered.

setOnMatrixChangeListener

public void setOnMatrixChangeListener(PhotoViewAttacher.OnMatrixChangedListener listener)

Description copied from interface: IPhotoView

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.

Specified by:

setOnMatrixChangeListener in interface IPhotoView

Parameters:

listener - - Listener to be registered.

setOnPhotoTapListener

public void setOnPhotoTapListener(PhotoViewAttacher.OnPhotoTapListener listener)

Description copied from interface: IPhotoView

Register a callback to be invoked when the Photo displayed by this View is tapped with a single tap.

Specified by:

setOnPhotoTapListener in interface IPhotoView

Parameters:

listener - - Listener to be registered.

getOnPhotoTapListener

public PhotoViewAttacher.OnPhotoTapListener getOnPhotoTapListener()

Description copied from interface: IPhotoView

Returns a listener to be invoked when the Photo displayed by this View is tapped with a single tap.

Specified by:

getOnPhotoTapListener in interface IPhotoView

Returns:

PhotoViewAttacher.OnPhotoTapListener currently set, may be null

setOnViewTapListener

public void setOnViewTapListener(PhotoViewAttacher.OnViewTapListener listener)

Description copied from interface: IPhotoView

Register a callback to be invoked when the View is tapped with a single tap.

Specified by:

setOnViewTapListener in interface IPhotoView

Parameters:

listener - - Listener to be registered.

getOnViewTapListener

public PhotoViewAttacher.OnViewTapListener getOnViewTapListener()

Description copied from interface: IPhotoView

Returns a callback listener to be invoked when the View is tapped with a single tap.

Specified by:

getOnViewTapListener in interface IPhotoView

Returns:

PhotoViewAttacher.OnViewTapListener currently set, may be null

setScale

public void setScale(float scale)

Description copied from interface: IPhotoView

Changes the current scale to the specified value.

Specified by:

setScale in interface IPhotoView

Parameters:

scale - - Value to scale to

setScale

public void setScale(float scale,
            boolean animate)

Description copied from interface: IPhotoView

Changes the current scale to the specified value.

Specified by:

setScale in interface IPhotoView

Parameters:

scale - - Value to scale to

animate - - Whether to animate the scale

setScale

public void setScale(float scale,
            float focalX,
            float focalY,
            boolean animate)

Description copied from interface: IPhotoView

Changes the current scale to the specified value, around the given focal point.

Specified by:

setScale in interface IPhotoView

Parameters:

scale - - Value to scale to

focalX - - X Focus Point

focalY - - Y Focus Point

animate - - Whether to animate the scale

setScaleType

public void setScaleType(android.widget.ImageView.ScaleType scaleType)

Description copied from interface: IPhotoView

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.

Specified by:

setScaleType in interface IPhotoView

Parameters:

scaleType - - The desired scaling mode.

setZoomable

public void setZoomable(boolean zoomable)

Description copied from interface: IPhotoView

Allows you to enable/disable the zoom functionality on the ImageView. When disable the ImageView reverts to using the FIT_CENTER matrix.

Specified by:

setZoomable in interface IPhotoView

Parameters:

zoomable - - Whether the zoom functionality is enabled.

update

public void update()

getDisplayMatrix

public android.graphics.Matrix getDisplayMatrix()

Description copied from interface: IPhotoView

Gets the Display Matrix of the currently displayed Drawable. The Rectangle is considered relative to this View and includes all scaling and translations.

Specified by:

getDisplayMatrix in interface IPhotoView

Returns:

- true if rectangle was applied successfully

getDrawMatrix

public android.graphics.Matrix getDrawMatrix()

getVisibleRectangleBitmap

public android.graphics.Bitmap getVisibleRectangleBitmap()

Description copied from interface: IPhotoView

Extracts currently visible area to Bitmap object, if there is no image loaded yet or the ImageView is already destroyed, returns null

Specified by:

getVisibleRectangleBitmap in interface IPhotoView

Returns:

currently visible area as bitmap or null

setZoomTransitionDuration

public void setZoomTransitionDuration(int milliseconds)

Description copied from interface: IPhotoView

Allows to change zoom transition speed, default value is 200 (PhotoViewAttacher.DEFAULT_ZOOM_DURATION). Will default to 200 if provided negative value

Specified by:

setZoomTransitionDuration in interface IPhotoView

Parameters:

milliseconds - duration of zoom interpolation

getIPhotoViewImplementation

public IPhotoView getIPhotoViewImplementation()

Description copied from interface: IPhotoView

Will return instance of IPhotoView (eg. PhotoViewAttacher), can be used to provide better integration

Specified by:

getIPhotoViewImplementation in interface IPhotoView

Returns:

IPhotoView implementation instance if available, null if not