com.hannesdorfmann.httpkit.image.photoview

Class PhotoViewAttacher

java.lang.Object

com.hannesdorfmann.httpkit.image.photoview.PhotoViewAttacher

All Implemented Interfaces:

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

public class PhotoViewAttacher
extends Object
implements IPhotoView, android.view.View.OnTouchListener, OnGestureListener, android.view.GestureDetector.OnDoubleTapListener, 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.OnViewTapListener Interface definition for a callback to be invoked when the ImageView is tapped with a single tap.

Field Summary

Fields

Modifier and Type	Field and Description
static float	DEFAULT_MAX_SCALE
static float	DEFAULT_MID_SCALE
static float	DEFAULT_MIN_SCALE

Constructor Summary

Constructors

Constructor and Description
PhotoViewAttacher(android.widget.ImageView imageView)

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.
protected android.graphics.Matrix	getDrawMatrix()
android.widget.ImageView	getImageView()
float	getMaximumScale()
float	getMaxScale() Deprecated.
float	getMediumScale()
float	getMidScale() Deprecated.
float	getMinimumScale()
float	getMinScale() Deprecated.
float	getScale() Returns the current scale value
android.widget.ImageView.ScaleType	getScaleType() Return the current scale type in use by the ImageView.
boolean	onDoubleTap(android.view.MotionEvent ev)
boolean	onDoubleTapEvent(android.view.MotionEvent e)
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	onSingleTapConfirmed(android.view.MotionEvent e)
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	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	setOnViewTapListener(PhotoViewAttacher.OnViewTapListener listener) Register a callback to be invoked when the View is tapped with a single tap.
void	setPhotoViewRotation(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	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	update()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_SCALE

public static final float DEFAULT_MAX_SCALE

See Also:

Constant Field Values

DEFAULT_MID_SCALE

public static final float DEFAULT_MID_SCALE

See Also:

Constant Field Values

DEFAULT_MIN_SCALE

public static final float DEFAULT_MIN_SCALE

See Also:

Constant Field Values

Constructor Detail

PhotoViewAttacher

public PhotoViewAttacher(android.widget.ImageView imageView)

Method Detail

canZoom

public final 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 final 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 uk.co.senab.photoview.PhotoView.

getDisplayRect

public final 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

Returns:

- true if rectangle was applied successfully

setPhotoViewRotation

public void setPhotoViewRotation(float degrees)

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 by, should be in range 0 to 360

getImageView

public final 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 final 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 final 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

onDoubleTap

public final boolean onDoubleTap(android.view.MotionEvent ev)

Specified by:

onDoubleTap in interface android.view.GestureDetector.OnDoubleTapListener

onDoubleTapEvent

public final boolean onDoubleTapEvent(android.view.MotionEvent e)

Specified by:

onDoubleTapEvent in interface android.view.GestureDetector.OnDoubleTapListener

onDrag

public final void onDrag(float dx,
          float dy)

Specified by:

onDrag in interface OnGestureListener

onFling

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

Specified by:

onFling in interface OnGestureListener

onGlobalLayout

public final void onGlobalLayout()

Specified by:

onGlobalLayout in interface android.view.ViewTreeObserver.OnGlobalLayoutListener

onScale

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

Specified by:

onScale in interface OnGestureListener

onSingleTapConfirmed

public final boolean onSingleTapConfirmed(android.view.MotionEvent e)

Specified by:

onSingleTapConfirmed in interface android.view.GestureDetector.OnDoubleTapListener

onTouch

public final 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

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

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

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

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

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

setOnLongClickListener

public final 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 final 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 final 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.

setOnViewTapListener

public final 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.

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 final 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 final 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 final 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

protected android.graphics.Matrix getDrawMatrix()