uk.co.senab.photoview

Interface IPhotoView

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canZoom() Returns true if the PhotoView is set to allow zooming of Photos.
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.
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	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 rotationDegree) Deprecated. use setRotationTo(float)
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

android.graphics.Matrix getDisplayMatrix()

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

Returns:

- true if rectangle was applied successfully

getMinScale

@Deprecated
float getMinScale()

Deprecated.

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

Returns:

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

getMinimumScale

float getMinimumScale()

Returns:

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

getMidScale

@Deprecated
float getMidScale()

Deprecated.

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

Returns:

The current middle 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.

getMaxScale

@Deprecated
float getMaxScale()

Deprecated.

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

Returns:

The current maximum 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

setMinScale

@Deprecated
void setMinScale(float minScale)

Deprecated.

Use 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.

Parameters:

minScale - minimum allowed scale

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

setMidScale

@Deprecated
void setMidScale(float midScale)

Deprecated.

Use 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.

Parameters:

midScale - medium scale preset

setMediumScale

void setMediumScale(float mediumScale)

setMaxScale

@Deprecated
void setMaxScale(float maxScale)

Deprecated.

Use 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.

Parameters:

maxScale - maximum allowed 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.

getOnPhotoTapListener

PhotoViewAttacher.OnPhotoTapListener getOnPhotoTapListener()

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

Returns:

PhotoViewAttacher.OnPhotoTapListener currently set, may be null

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

getOnViewTapListener

PhotoViewAttacher.OnViewTapListener getOnViewTapListener()

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

Returns:

PhotoViewAttacher.OnViewTapListener currently set, may be null

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.

setPhotoViewRotation

void setPhotoViewRotation(float rotationDegree)

Deprecated. use setRotationTo(float)

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

Parameters:

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

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