Android-IMKit-SDK/io.rong.imkit.picture.widget.longimage/SubsamplingScaleImageView

SubsamplingScaleImageView

Displays an image subsampled as necessary to avoid loading too much image data into memory. After a pinch to zoom in, a set of image tiles subsampled at higher resolution are loaded and displayed over the base layer. During pinch and zoom, tiles off screen or higher/lower resolution than required are discarded from memory.

Tiles are no larger than the max supported bitmap size, so with large images tiling may be used even when zoomed out.

v prefixes - coordinates, translations and distances measured in screen (view) pixels s prefixes - coordinates, translations and distances measured in source image pixels (scaled)

Constructors

public void SubsamplingScaleImageView(Context context, AttributeSet attr)

public void SubsamplingScaleImageView(Context context)

Types

AnimationBuilder

public final class AnimationBuilder

Builder class used to set additional options for a scale animation.

DefaultOnAnimationEventListener

public class DefaultOnAnimationEventListener implements SubsamplingScaleImageView.OnAnimationEventListener

Default implementation of OnAnimationEventListener for extension.

DefaultOnImageEventListener

public class DefaultOnImageEventListener implements SubsamplingScaleImageView.OnImageEventListener

Default implementation of OnImageEventListener for extension.

DefaultOnStateChangedListener

public class DefaultOnStateChangedListener implements SubsamplingScaleImageView.OnStateChangedListener

Default implementation of OnStateChangedListener.

OnAnimationEventListener

public interface OnAnimationEventListener

An event listener for animations, allows events to be triggered when an animation completes, is aborted by another animation starting, or is aborted by a touch event.

OnImageEventListener

public interface OnImageEventListener

An event listener, allowing subclasses and activities to be notified of significant events.

OnStateChangedListener

public interface OnStateChangedListener

An event listener, allowing activities to be notified of pan and zoom events.

Properties

EASE_IN_OUT_QUAD

public final static int EASE_IN_OUT_QUAD

Quadratic ease in and out.

EASE_OUT_QUAD

public final static int EASE_OUT_QUAD

Quadratic ease out.

maxScale

public float maxScale

minScale

public float minScale

orientation

public int orientation

ORIENTATION_0

public final static int ORIENTATION_0

Display the image file in its native orientation.

ORIENTATION_180

public final static int ORIENTATION_180

Rotate the image 180 degrees.

ORIENTATION_270

public final static int ORIENTATION_270

Rotate the image 270 degrees clockwise.

ORIENTATION_90

public final static int ORIENTATION_90

Rotate the image 90 degrees clockwise.

ORIENTATION_USE_EXIF

public final static int ORIENTATION_USE_EXIF

Attempt to use EXIF information on the image to rotate it.

ORIGIN_ANIM

public final static int ORIGIN_ANIM

State change originated from animation.

ORIGIN_DOUBLE_TAP_ZOOM

public final static int ORIGIN_DOUBLE_TAP_ZOOM

State change originated from a double tap zoom anim.

ORIGIN_FLING

public final static int ORIGIN_FLING

State change originated from a fling momentum anim.

ORIGIN_TOUCH

public final static int ORIGIN_TOUCH

State change originated from touch gesture.

PAN_LIMIT_CENTER

public final static int PAN_LIMIT_CENTER

Allows the image to be panned until a corner reaches the center of the screen but no further.

PAN_LIMIT_INSIDE

public final static int PAN_LIMIT_INSIDE

Don't allow the image to be panned off screen.

PAN_LIMIT_OUTSIDE

public final static int PAN_LIMIT_OUTSIDE

Allows the image to be panned until it is just off screen, but no further.

preferredBitmapConfig

public static Config preferredBitmapConfig

scale

public float scale

SCALE_TYPE_CENTER_CROP

public final static int SCALE_TYPE_CENTER_CROP

Scale the image uniformly so that both dimensions of the image will be equal to or larger than the corresponding dimension of the view.

SCALE_TYPE_CENTER_INSIDE

public final static int SCALE_TYPE_CENTER_INSIDE

Scale the image so that both dimensions of the image will be equal to or less than the corresponding dimension of the view.

SCALE_TYPE_CUSTOM

public final static int SCALE_TYPE_CUSTOM

Scale the image so that both dimensions of the image will be equal to or less than the maxScale and equal to or larger than minScale.

SCALE_TYPE_START

public final static int SCALE_TYPE_START

Scale the image so that both dimensions of the image will be equal to or larger than the corresponding dimension of the view.

sHeight

public int sHeight

sWidth

public int sWidth

TILE_SIZE_AUTO

public final static int TILE_SIZE_AUTO

uri

public Uri uri

ZOOM_FOCUS_CENTER

public final static int ZOOM_FOCUS_CENTER

During zoom animation, move the point of the image that was tapped to the center of the screen.

ZOOM_FOCUS_CENTER_IMMEDIATE

public final static int ZOOM_FOCUS_CENTER_IMMEDIATE

Zoom in to and center the tapped point immediately without animating.

ZOOM_FOCUS_FIXED

public final static int ZOOM_FOCUS_FIXED

During zoom animation, keep the point of the image that was tapped in the same place, and scale the image around it.

Functions

animateCenter

public SubsamplingScaleImageView.AnimationBuilder animateCenter(PointF sCenter)

Creates a panning animation builder, that when started will animate the image to place the given coordinates of the image in the center of the screen.

animateScale

public SubsamplingScaleImageView.AnimationBuilder animateScale(float scale)

Creates a scale animation builder, that when started will animate a zoom in or out.

animateScaleAndCenter

public SubsamplingScaleImageView.AnimationBuilder animateScaleAndCenter(float scale, PointF sCenter)

Creates a scale animation builder, that when started will animate a zoom in or out.

getAppliedOrientation

public final int getAppliedOrientation()

Returns the actual orientation of the image relative to the source file.

getCenter

public final PointF getCenter()

Returns the source point at the center of the view.

getMaxScale

public float getMaxScale()

Returns the maximum allowed scale.

getMinScale

public final float getMinScale()

Returns the minimum allowed scale.

getOrientation

public final int getOrientation()

Returns the orientation setting.

getPanRemaining

public final void getPanRemaining(RectF vTarget)

Calculate how much further the image can be panned in each direction.

getPreferredBitmapConfig

public static Config getPreferredBitmapConfig()

Get the current preferred configuration for decoding bitmaps.

getScale

public final float getScale()

Returns the current scale value.

getSHeight

public final int getSHeight()

Get source height, ignoring orientation.

getState

public final ImageViewState getState()

Get the current state of the view (scale, center, orientation) for restoration after rotate.

getSWidth

public final int getSWidth()

Get source width, ignoring orientation.

getUri

public Uri getUri()

Return the uri that has been set.

hasImage

public boolean hasImage()

Check if an image has been set.

isImageLoaded

public final boolean isImageLoaded()

Call to find whether the main image (base layer tiles where relevant) have been loaded.

isPanEnabled

public final boolean isPanEnabled()

Returns true if pan gesture detection is enabled.

isQuickScaleEnabled

public final boolean isQuickScaleEnabled()

Returns true if double tap &swipe to zoom is enabled.

isReady

public final boolean isReady()

Call to find whether the view is initialised, has dimensions, and will display an image on the next draw.

isZoomEnabled

public final boolean isZoomEnabled()

Returns true if zoom gesture detection is enabled.

onTouchEvent

public boolean onTouchEvent(MotionEvent event)

Handle touch events.

recycle

public void recycle()

Releases all resources the view is using and resets the state, nulling any fields that use significant memory.

resetScaleAndCenter

public final void resetScaleAndCenter()

Fully zoom out and return the image to the middle of the screen.

setBitmapAndFileUri

public final void setBitmapAndFileUri(Bitmap bitmap, Uri fileUri)

setBitmapDecoderClass

public final void setBitmapDecoderClass(Class<? extends ImageDecoder> bitmapDecoderClass)

Swap the default bitmap decoder implementation for one of your own.

setBitmapDecoderFactory

public final void setBitmapDecoderFactory(DecoderFactory<? extends ImageDecoder> bitmapDecoderFactory)

Swap the default bitmap decoder implementation for one of your own.

setBitmapFitX

public final void setBitmapFitX(Bitmap bitmap)

bitmap 展示以X轴为准,填充满X轴

setDebug

public final void setDebug(boolean debug)

Enables visual debugging, showing tile boundaries and sizes.

setDoubleTapZoomDpi

public final void setDoubleTapZoomDpi(int dpi)

A density aware alternative to setDoubleTapZoomScale; this allows you to express the scale the image will zoom in to when double tapped in terms of the image pixel density.

setDoubleTapZoomDuration

public final void setDoubleTapZoomDuration(int durationMs)

Set the duration of the double tap zoom animation.

setDoubleTapZoomScale

public final void setDoubleTapZoomScale(float doubleTapZoomScale)

Set the scale the image will zoom in to when double tapped.

setDoubleTapZoomStyle

public final void setDoubleTapZoomStyle(int doubleTapZoomStyle)

Set the type of zoom animation to be used for double taps.

setEagerLoadingEnabled

public void setEagerLoadingEnabled(boolean eagerLoadingEnabled)

Enable or disable eager loading of tiles that appear on screen during gestures or animations, while the gesture or animation is still in progress.

setExecutor

public void setExecutor(Executor executor)

Provide an Executor to be used for loading images.

setImage

public final void setImage(ImageSource imageSource)

Set the image source from a bitmap, resource, asset, file or other URI.

public final void setImage(ImageSource imageSource, ImageSource previewSource)

Set the image source from a bitmap, resource, asset, file or other URI, providing a preview image to be displayed until the full size image is loaded.

public final void setImage(ImageSource imageSource, ImageViewState state)

Set the image source from a bitmap, resource, asset, file or other URI, starting with a given orientation setting, scale and center.

public final void setImage(ImageSource imageSource, ImageSource previewSource, ImageViewState state)

Set the image source from a bitmap, resource, asset, file or other URI, providing a preview image to be displayed until the full size image is loaded, starting with a given orientation setting, scale and center.

setMaximumDpi

public final void setMaximumDpi(int dpi)

This is a screen density aware alternative to setMinScale; it allows you to express the minimum allowed scale in terms of the maximum pixel density.

setMaxScale

public final void setMaxScale(float maxScale)

Set the maximum scale allowed.

setMaxTileSize

public void setMaxTileSize(int maxPixels)

public void setMaxTileSize(int maxPixelsX, int maxPixelsY)

By default the View automatically calculates the optimal tile size.

setMinimumDpi

public final void setMinimumDpi(int dpi)

This is a screen density aware alternative to setMaxScale; it allows you to express the maximum allowed scale in terms of the minimum pixel density.

setMinimumScaleType

public final void setMinimumScaleType(int scaleType)

Set the minimum scale type.

setMinimumTileDpi

public void setMinimumTileDpi(int minimumTileDpi)

By default, image tiles are at least as high resolution as the screen.

setMinScale

public final void setMinScale(float minScale)

Set the minimum scale allowed.

setOnImageEventListener

public void setOnImageEventListener(SubsamplingScaleImageView.OnImageEventListener onImageEventListener)

Add a listener allowing notification of load and error events.

setOnLongClickListener

public void setOnLongClickListener(OnLongClickListener onLongClickListener)

setOnStateChangedListener

public void setOnStateChangedListener(SubsamplingScaleImageView.OnStateChangedListener onStateChangedListener)

Add a listener for pan and zoom events.

setOrientation

public final void setOrientation(int orientation)

Sets the image orientation.

setPanEnabled

public final void setPanEnabled(boolean panEnabled)

Enable or disable pan gesture detection.

setPanLimit

public final void setPanLimit(int panLimit)

Set the pan limiting style.

setPreferredBitmapConfig

public static void setPreferredBitmapConfig(Config preferredBitmapConfig)

Set a global preferred bitmap config shared by all view instances and applied to new instances initialised after the call is made.

setQuickScaleEnabled

public final void setQuickScaleEnabled(boolean quickScaleEnabled)

Enable or disable double tap &swipe to zoom.

setRegionDecoderClass

public final void setRegionDecoderClass(Class<? extends ImageRegionDecoder> regionDecoderClass)

Swap the default region decoder implementation for one of your own.

setRegionDecoderFactory

public final void setRegionDecoderFactory(DecoderFactory<? extends ImageRegionDecoder> regionDecoderFactory)

Swap the default region decoder implementation for one of your own.

setScaleAndCenter

public final void setScaleAndCenter(float scale, PointF sCenter)

Externally change the scale and translation of the source image.

setTileBackgroundColor

public final void setTileBackgroundColor(int tileBgColor)

Set a solid color to render behind tiles, useful for displaying transparent PNGs.

setZoomEnabled

public final void setZoomEnabled(boolean zoomEnabled)

Enable or disable zoom gesture detection.

sourceToViewCoord

public final PointF sourceToViewCoord(PointF sxy)

public final PointF sourceToViewCoord(PointF sxy, PointF vTarget)

public final PointF sourceToViewCoord(float sx, float sy)

public final PointF sourceToViewCoord(float sx, float sy, PointF vTarget)

Convert source coordinate to view coordinate.

viewToFileRect

public void viewToFileRect(Rect vRect, Rect fRect)

Converts a rectangle within the view to the corresponding rectangle from the source file, taking into account the current scale, translation, orientation and clipped region.

viewToSourceCoord

public final PointF viewToSourceCoord(PointF vxy)

public final PointF viewToSourceCoord(PointF vxy, PointF sTarget)

public final PointF viewToSourceCoord(float vx, float vy)

public final PointF viewToSourceCoord(float vx, float vy, PointF sTarget)

Convert screen coordinate to source coordinate.

visibleFileRect

public void visibleFileRect(Rect fRect)

Find the area of the source file that is currently visible on screen, taking into account the current scale, translation, orientation and clipped region.