public final class ImageSource extends Object
dimensions(int, int) method.| Modifier and Type | Method and Description |
|---|---|
static ImageSource |
asset(String assetName)
Create an instance from an asset name.
|
static ImageSource |
bitmap(Bitmap bitmap)
Provide a loaded bitmap for display.
|
static ImageSource |
cachedBitmap(Bitmap bitmap)
Provide a loaded and cached bitmap for display.
|
ImageSource |
dimensions(int sWidth,
int sHeight)
Declare the dimensions of the image.
|
protected Bitmap |
getBitmap() |
protected Integer |
getResource() |
protected int |
getSHeight() |
protected Rect |
getSRegion() |
protected int |
getSWidth() |
protected boolean |
getTile() |
protected Uri |
getUri() |
protected boolean |
isCached() |
ImageSource |
region(Rect sRegion)
Use a region of the source image.
|
static ImageSource |
resource(int resId)
Create an instance from a resource.
|
ImageSource |
tiling(boolean tile)
Enable or disable tiling of the image.
|
ImageSource |
tilingDisabled()
Disable tiling of the image.
|
ImageSource |
tilingEnabled()
Enable tiling of the image.
|
static ImageSource |
uri(String uri)
Create an instance from a URI.
|
static ImageSource |
uri(Uri uri)
Create an instance from a URI.
|
@NonNull public static ImageSource resource(int resId)
resId - resource ID.ImageSource instance.@NonNull public static ImageSource asset(@NonNull String assetName)
assetName - asset name.ImageSource instance.@NonNull public static ImageSource uri(@NonNull String uri)
uri - image URI.ImageSource instance.@NonNull public static ImageSource uri(@NonNull Uri uri)
uri - image URI.ImageSource instance.@NonNull public static ImageSource bitmap(@NonNull Bitmap bitmap)
bitmap - bitmap to be displayed.ImageSource instance.@NonNull public static ImageSource cachedBitmap(@NonNull Bitmap bitmap)
bitmap - bitmap to be displayed.ImageSource instance.@NonNull public ImageSource tilingEnabled()
@NonNull public ImageSource tilingDisabled()
@NonNull public ImageSource tiling(boolean tile)
tile - whether tiling should be enabled.@NonNull public ImageSource region(Rect sRegion)
sRegion - the region of the source image to be displayed.@NonNull public ImageSource dimensions(int sWidth, int sHeight)
sWidth - width of the source image.sHeight - height of the source image.protected final Uri getUri()
protected final Bitmap getBitmap()
protected final Integer getResource()
protected final boolean getTile()
protected final int getSWidth()
protected final int getSHeight()
protected final Rect getSRegion()
protected final boolean isCached()
public class ImageViewState extends Object implements Serializable
| Constructor and Description |
|---|
ImageViewState(float scale,
PointF center,
int orientation) |
public final class SubsamplingScaleImageView.AnimationBuilder extends Object
SubsamplingScaleImageView.animateScale(float),
then set your options and call start().| Modifier and Type | Method and Description |
|---|---|
void |
start()
Starts the animation.
|
SubsamplingScaleImageView.AnimationBuilder |
withDuration(long duration)
Desired duration of the anim in milliseconds.
|
SubsamplingScaleImageView.AnimationBuilder |
withEasing(int easing)
Set the easing style.
|
SubsamplingScaleImageView.AnimationBuilder |
withInterruptible(boolean interruptible)
Whether the animation can be interrupted with a touch.
|
SubsamplingScaleImageView.AnimationBuilder |
withOnAnimationEventListener(SubsamplingScaleImageView.OnAnimationEventListener listener)
Add an animation event listener.
|
@NonNull public SubsamplingScaleImageView.AnimationBuilder withDuration(long duration)
duration - duration in milliseconds.@NonNull public SubsamplingScaleImageView.AnimationBuilder withInterruptible(boolean interruptible)
interruptible - interruptible flag.@NonNull public SubsamplingScaleImageView.AnimationBuilder withEasing(int easing)
SubsamplingScaleImageView.EASE_IN_OUT_QUAD is recommended, and the default.easing - easing style.@NonNull public SubsamplingScaleImageView.AnimationBuilder withOnAnimationEventListener(SubsamplingScaleImageView.OnAnimationEventListener listener)
listener - The listener.public void start()
public static class SubsamplingScaleImageView.DefaultOnAnimationEventListener extends Object implements SubsamplingScaleImageView.OnAnimationEventListener
SubsamplingScaleImageView.OnAnimationEventListener for extension. This does nothing in any method.| Constructor and Description |
|---|
DefaultOnAnimationEventListener() |
| Modifier and Type | Method and Description |
|---|---|
void |
onComplete()
The animation has completed, having reached its endpoint.
|
void |
onInterruptedByNewAnim()
The animation has been aborted before reaching its endpoint because a new animation has been started.
|
void |
onInterruptedByUser()
The animation has been aborted before reaching its endpoint because the user touched the screen.
|
public void onComplete()
SubsamplingScaleImageView.OnAnimationEventListeneronComplete in interface SubsamplingScaleImageView.OnAnimationEventListenerpublic void onInterruptedByUser()
SubsamplingScaleImageView.OnAnimationEventListeneronInterruptedByUser in interface SubsamplingScaleImageView.OnAnimationEventListenerpublic void onInterruptedByNewAnim()
SubsamplingScaleImageView.OnAnimationEventListeneronInterruptedByNewAnim in interface SubsamplingScaleImageView.OnAnimationEventListenerpublic static class SubsamplingScaleImageView.DefaultOnImageEventListener extends Object implements SubsamplingScaleImageView.OnImageEventListener
SubsamplingScaleImageView.OnImageEventListener for extension. This does nothing in any method.| Constructor and Description |
|---|
DefaultOnImageEventListener() |
| Modifier and Type | Method and Description |
|---|---|
void |
onImageLoaded()
Called when the full size image is ready.
|
void |
onImageLoadError(Exception e)
Indicates an error initiliasing the decoder when using a tiling, or when loading the full
size bitmap when tiling is disabled.
|
void |
onPreviewLoadError(Exception e)
Called when a preview image could not be loaded.
|
void |
onPreviewReleased()
Called when a bitmap set using ImageSource.cachedBitmap is no longer being used by the View.
|
void |
onReady()
Called when the dimensions of the image and view are known, and either a preview image,
the full size image, or base layer tiles are loaded.
|
void |
onTileLoadError(Exception e)
Called when an image tile could not be loaded.
|
public void onReady()
SubsamplingScaleImageView.OnImageEventListeneronReady in interface SubsamplingScaleImageView.OnImageEventListenerpublic void onImageLoaded()
SubsamplingScaleImageView.OnImageEventListenerSubsamplingScaleImageView.OnImageEventListener.onReady() is the best
event to listen to.onImageLoaded in interface SubsamplingScaleImageView.OnImageEventListenerpublic void onPreviewLoadError(Exception e)
SubsamplingScaleImageView.OnImageEventListeneronPreviewLoadError in interface SubsamplingScaleImageView.OnImageEventListenere - The exception thrown. This error is logged by the view.public void onImageLoadError(Exception e)
SubsamplingScaleImageView.OnImageEventListeneronImageLoadError in interface SubsamplingScaleImageView.OnImageEventListenere - The exception thrown. This error is also logged by the view.public void onTileLoadError(Exception e)
SubsamplingScaleImageView.OnImageEventListenerSubsamplingScaleImageView.OnImageEventListener.onImageLoadError(Exception).onTileLoadError in interface SubsamplingScaleImageView.OnImageEventListenere - The exception thrown. This error is logged by the view.public void onPreviewReleased()
SubsamplingScaleImageView.OnImageEventListeneronPreviewReleased in interface SubsamplingScaleImageView.OnImageEventListenerpublic static class SubsamplingScaleImageView.DefaultOnStateChangedListener extends Object implements SubsamplingScaleImageView.OnStateChangedListener
SubsamplingScaleImageView.OnStateChangedListener. This does nothing in any method.| Constructor and Description |
|---|
DefaultOnStateChangedListener() |
| Modifier and Type | Method and Description |
|---|---|
void |
onCenterChanged(PointF newCenter,
int origin)
The source center has been changed.
|
void |
onScaleChanged(float newScale,
int origin)
The scale has changed.
|
public void onCenterChanged(PointF newCenter, int origin)
SubsamplingScaleImageView.OnStateChangedListeneronCenterChanged in interface SubsamplingScaleImageView.OnStateChangedListenernewCenter - The new source center point.origin - Where the event originated from - one of SubsamplingScaleImageView.ORIGIN_ANIM, SubsamplingScaleImageView.ORIGIN_TOUCH.public void onScaleChanged(float newScale,
int origin)
SubsamplingScaleImageView.OnStateChangedListenerSubsamplingScaleImageView.getMaxScale() and SubsamplingScaleImageView.getMinScale() to determine
whether the image is fully zoomed in or out.onScaleChanged in interface SubsamplingScaleImageView.OnStateChangedListenernewScale - The new scale.origin - Where the event originated from - one of SubsamplingScaleImageView.ORIGIN_ANIM, SubsamplingScaleImageView.ORIGIN_TOUCH.public static interface SubsamplingScaleImageView.OnAnimationEventListener
| Modifier and Type | Method and Description |
|---|---|
void |
onComplete()
The animation has completed, having reached its endpoint.
|
void |
onInterruptedByNewAnim()
The animation has been aborted before reaching its endpoint because a new animation has been started.
|
void |
onInterruptedByUser()
The animation has been aborted before reaching its endpoint because the user touched the screen.
|
void onComplete()
void onInterruptedByUser()
void onInterruptedByNewAnim()
public static interface SubsamplingScaleImageView.OnImageEventListener
| Modifier and Type | Method and Description |
|---|---|
void |
onImageLoaded()
Called when the full size image is ready.
|
void |
onImageLoadError(Exception e)
Indicates an error initiliasing the decoder when using a tiling, or when loading the full
size bitmap when tiling is disabled.
|
void |
onPreviewLoadError(Exception e)
Called when a preview image could not be loaded.
|
void |
onPreviewReleased()
Called when a bitmap set using ImageSource.cachedBitmap is no longer being used by the View.
|
void |
onReady()
Called when the dimensions of the image and view are known, and either a preview image,
the full size image, or base layer tiles are loaded.
|
void |
onTileLoadError(Exception e)
Called when an image tile could not be loaded.
|
void onReady()
void onImageLoaded()
onReady() is the best
event to listen to.void onPreviewLoadError(Exception e)
e - The exception thrown. This error is logged by the view.void onImageLoadError(Exception e)
e - The exception thrown. This error is also logged by the view.void onTileLoadError(Exception e)
onImageLoadError(Exception).e - The exception thrown. This error is logged by the view.void onPreviewReleased()
public static interface SubsamplingScaleImageView.OnStateChangedListener
| Modifier and Type | Method and Description |
|---|---|
void |
onCenterChanged(PointF newCenter,
int origin)
The source center has been changed.
|
void |
onScaleChanged(float newScale,
int origin)
The scale has changed.
|
void onScaleChanged(float newScale,
int origin)
SubsamplingScaleImageView.getMaxScale() and SubsamplingScaleImageView.getMinScale() to determine
whether the image is fully zoomed in or out.newScale - The new scale.origin - Where the event originated from - one of SubsamplingScaleImageView.ORIGIN_ANIM, SubsamplingScaleImageView.ORIGIN_TOUCH.void onCenterChanged(PointF newCenter, int origin)
newCenter - The new source center point.origin - Where the event originated from - one of SubsamplingScaleImageView.ORIGIN_ANIM, SubsamplingScaleImageView.ORIGIN_TOUCH.public class SubsamplingScaleImageView extends View
Displays an image subsampled as necessary to avoid loading too much image data into memory. After zooming in, a set of image tiles subsampled at higher resolution are loaded and displayed over the base layer. During pan 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 rotated and cropped source image pixels (scaled)
f prefixes - coordinates, translations and distances measured in original unrotated, uncropped source file pixels
| Modifier and Type | Class and Description |
|---|---|
class |
SubsamplingScaleImageView.AnimationBuilder
Builder class used to set additional options for a scale animation.
|
static class |
SubsamplingScaleImageView.DefaultOnAnimationEventListener
Default implementation of
SubsamplingScaleImageView.OnAnimationEventListener for extension. |
static class |
SubsamplingScaleImageView.DefaultOnImageEventListener
Default implementation of
SubsamplingScaleImageView.OnImageEventListener for extension. |
static class |
SubsamplingScaleImageView.DefaultOnStateChangedListener
Default implementation of
SubsamplingScaleImageView.OnStateChangedListener. |
static interface |
SubsamplingScaleImageView.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.
|
static interface |
SubsamplingScaleImageView.OnImageEventListener
An event listener, allowing subclasses and activities to be notified of significant events.
|
static interface |
SubsamplingScaleImageView.OnStateChangedListener
An event listener, allowing activities to be notified of pan and zoom events.
|
View.AccessibilityDelegate, View.BaseSavedState, View.DragShadowBuilder, View.MeasureSpec, View.OnApplyWindowInsetsListener, View.OnAttachStateChangeListener, View.OnCapturedPointerListener, View.OnClickListener, View.OnContextClickListener, View.OnCreateContextMenuListener, View.OnDragListener, View.OnFocusChangeListener, View.OnGenericMotionListener, View.OnHoverListener, View.OnKeyListener, View.OnLayoutChangeListener, View.OnLongClickListener, View.OnScrollChangeListener, View.OnSystemUiVisibilityChangeListener, View.OnTouchListener| Modifier and Type | Field and Description |
|---|---|
static int |
EASE_IN_OUT_QUAD
Quadratic ease in and out.
|
static int |
EASE_OUT_QUAD
Quadratic ease out.
|
static int |
ORIENTATION_0
Display the image file in its native orientation.
|
static int |
ORIENTATION_180
Rotate the image 180 degrees.
|
static int |
ORIENTATION_270
Rotate the image 270 degrees clockwise.
|
static int |
ORIENTATION_90
Rotate the image 90 degrees clockwise.
|
static int |
ORIENTATION_USE_EXIF
Attempt to use EXIF information on the image to rotate it.
|
static int |
ORIGIN_ANIM
State change originated from animation.
|
static int |
ORIGIN_DOUBLE_TAP_ZOOM
State change originated from a double tap zoom anim.
|
static int |
ORIGIN_FLING
State change originated from a fling momentum anim.
|
static int |
ORIGIN_TOUCH
State change originated from touch gesture.
|
static int |
PAN_LIMIT_CENTER
Allows the image to be panned until a corner reaches the center of the screen but no further.
|
static int |
PAN_LIMIT_INSIDE
Don't allow the image to be panned off screen.
|
static int |
PAN_LIMIT_OUTSIDE
Allows the image to be panned until it is just off screen, but no further.
|
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.
|
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.
|
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.
|
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.
|
static int |
TILE_SIZE_AUTO |
static int |
ZOOM_FOCUS_CENTER
During zoom animation, move the point of the image that was tapped to the center of the screen.
|
static int |
ZOOM_FOCUS_CENTER_IMMEDIATE
Zoom in to and center the tapped point immediately without animating.
|
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.
|
ACCESSIBILITY_LIVE_REGION_ASSERTIVE, ACCESSIBILITY_LIVE_REGION_NONE, ACCESSIBILITY_LIVE_REGION_POLITE, ALPHA, AUTOFILL_FLAG_INCLUDE_NOT_IMPORTANT_VIEWS, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAY, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTH, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEAR, AUTOFILL_HINT_CREDIT_CARD_NUMBER, AUTOFILL_HINT_CREDIT_CARD_SECURITY_CODE, AUTOFILL_HINT_EMAIL_ADDRESS, AUTOFILL_HINT_NAME, AUTOFILL_HINT_PASSWORD, AUTOFILL_HINT_PHONE, AUTOFILL_HINT_POSTAL_ADDRESS, AUTOFILL_HINT_POSTAL_CODE, AUTOFILL_HINT_USERNAME, AUTOFILL_TYPE_DATE, AUTOFILL_TYPE_LIST, AUTOFILL_TYPE_NONE, AUTOFILL_TYPE_TEXT, AUTOFILL_TYPE_TOGGLE, DRAG_FLAG_GLOBAL, DRAG_FLAG_GLOBAL_PERSISTABLE_URI_PERMISSION, DRAG_FLAG_GLOBAL_PREFIX_URI_PERMISSION, DRAG_FLAG_GLOBAL_URI_READ, DRAG_FLAG_GLOBAL_URI_WRITE, DRAG_FLAG_OPAQUE, DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_HIGH, DRAWING_CACHE_QUALITY_LOW, EMPTY_STATE_SET, ENABLED_FOCUSED_SELECTED_STATE_SET, ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, ENABLED_FOCUSED_STATE_SET, ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET, ENABLED_SELECTED_STATE_SET, ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET, ENABLED_STATE_SET, ENABLED_WINDOW_FOCUSED_STATE_SET, FIND_VIEWS_WITH_CONTENT_DESCRIPTION, FIND_VIEWS_WITH_TEXT, FOCUS_BACKWARD, FOCUS_DOWN, FOCUS_FORWARD, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_UP, FOCUSABLE, FOCUSABLE_AUTO, FOCUSABLES_ALL, FOCUSABLES_TOUCH_MODE, FOCUSED_SELECTED_STATE_SET, FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, FOCUSED_STATE_SET, FOCUSED_WINDOW_FOCUSED_STATE_SET, GONE, HAPTIC_FEEDBACK_ENABLED, IMPORTANT_FOR_ACCESSIBILITY_AUTO, IMPORTANT_FOR_ACCESSIBILITY_NO, IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS, IMPORTANT_FOR_ACCESSIBILITY_YES, IMPORTANT_FOR_AUTOFILL_AUTO, IMPORTANT_FOR_AUTOFILL_NO, IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS, IMPORTANT_FOR_AUTOFILL_YES, IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS, INVISIBLE, KEEP_SCREEN_ON, LAYER_TYPE_HARDWARE, LAYER_TYPE_NONE, LAYER_TYPE_SOFTWARE, LAYOUT_DIRECTION_INHERIT, LAYOUT_DIRECTION_LOCALE, LAYOUT_DIRECTION_LTR, LAYOUT_DIRECTION_RTL, MEASURED_HEIGHT_STATE_SHIFT, MEASURED_SIZE_MASK, MEASURED_STATE_MASK, MEASURED_STATE_TOO_SMALL, NO_ID, NOT_FOCUSABLE, OVER_SCROLL_ALWAYS, OVER_SCROLL_IF_CONTENT_SCROLLS, OVER_SCROLL_NEVER, PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET, PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_ENABLED_FOCUSED_STATE_SET, PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET, PRESSED_ENABLED_SELECTED_STATE_SET, PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_ENABLED_STATE_SET, PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET, PRESSED_FOCUSED_SELECTED_STATE_SET, PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_FOCUSED_STATE_SET, PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET, PRESSED_SELECTED_STATE_SET, PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_STATE_SET, PRESSED_WINDOW_FOCUSED_STATE_SET, ROTATION, ROTATION_X, ROTATION_Y, SCALE_X, SCALE_Y, SCREEN_STATE_OFF, SCREEN_STATE_ON, SCROLL_AXIS_HORIZONTAL, SCROLL_AXIS_NONE, SCROLL_AXIS_VERTICAL, SCROLL_INDICATOR_BOTTOM, SCROLL_INDICATOR_END, SCROLL_INDICATOR_LEFT, SCROLL_INDICATOR_RIGHT, SCROLL_INDICATOR_START, SCROLL_INDICATOR_TOP, SCROLLBAR_POSITION_DEFAULT, SCROLLBAR_POSITION_LEFT, SCROLLBAR_POSITION_RIGHT, SCROLLBARS_INSIDE_INSET, SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_OUTSIDE_INSET, SCROLLBARS_OUTSIDE_OVERLAY, SELECTED_STATE_SET, SELECTED_WINDOW_FOCUSED_STATE_SET, SOUND_EFFECTS_ENABLED, STATUS_BAR_HIDDEN, STATUS_BAR_VISIBLE, SYSTEM_UI_FLAG_FULLSCREEN, SYSTEM_UI_FLAG_HIDE_NAVIGATION, SYSTEM_UI_FLAG_IMMERSIVE, SYSTEM_UI_FLAG_IMMERSIVE_STICKY, SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN, SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION, SYSTEM_UI_FLAG_LAYOUT_STABLE, SYSTEM_UI_FLAG_LIGHT_NAVIGATION_BAR, SYSTEM_UI_FLAG_LIGHT_STATUS_BAR, SYSTEM_UI_FLAG_LOW_PROFILE, SYSTEM_UI_FLAG_VISIBLE, SYSTEM_UI_LAYOUT_FLAGS, TEXT_ALIGNMENT_CENTER, TEXT_ALIGNMENT_GRAVITY, TEXT_ALIGNMENT_INHERIT, TEXT_ALIGNMENT_TEXT_END, TEXT_ALIGNMENT_TEXT_START, TEXT_ALIGNMENT_VIEW_END, TEXT_ALIGNMENT_VIEW_START, TEXT_DIRECTION_ANY_RTL, TEXT_DIRECTION_FIRST_STRONG, TEXT_DIRECTION_FIRST_STRONG_LTR, TEXT_DIRECTION_FIRST_STRONG_RTL, TEXT_DIRECTION_INHERIT, TEXT_DIRECTION_LOCALE, TEXT_DIRECTION_LTR, TEXT_DIRECTION_RTL, TRANSLATION_X, TRANSLATION_Y, TRANSLATION_Z, VIEW_LOG_TAG, VISIBLE, WINDOW_FOCUSED_STATE_SET, X, Y, Z| Constructor and Description |
|---|
SubsamplingScaleImageView(Context context) |
SubsamplingScaleImageView(Context context,
AttributeSet attr) |
| Modifier and Type | Method and Description |
|---|---|
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.
|
SubsamplingScaleImageView.AnimationBuilder |
animateScale(float scale)
Creates a scale animation builder, that when started will animate a zoom in or out.
|
SubsamplingScaleImageView.AnimationBuilder |
animateScaleAndCenter(float scale,
PointF sCenter)
Creates a scale animation builder, that when started will animate a zoom in or out.
|
int |
getAppliedOrientation()
Returns the actual orientation of the image relative to the source file.
|
PointF |
getCenter()
Returns the source point at the center of the view.
|
float |
getMaxScale()
Returns the maximum allowed scale.
|
float |
getMinScale()
Returns the minimum allowed scale.
|
int |
getOrientation()
Returns the orientation setting.
|
void |
getPanRemaining(RectF vTarget)
Calculate how much further the image can be panned in each direction.
|
static Bitmap.Config |
getPreferredBitmapConfig()
Get the current preferred configuration for decoding bitmaps.
|
float |
getScale()
Returns the current scale value.
|
int |
getSHeight()
Get source height, ignoring orientation.
|
ImageViewState |
getState()
Get the current state of the view (scale, center, orientation) for restoration after rotate.
|
int |
getSWidth()
Get source width, ignoring orientation.
|
boolean |
hasImage()
Check if an image has been set.
|
boolean |
isImageLoaded()
Call to find whether the main image (base layer tiles where relevant) have been loaded.
|
boolean |
isPanEnabled()
Returns true if pan gesture detection is enabled.
|
boolean |
isQuickScaleEnabled()
Returns true if double tap & swipe to zoom is enabled.
|
boolean |
isReady()
Call to find whether the view is initialised, has dimensions, and will display an image on
the next draw.
|
boolean |
isZoomEnabled()
Returns true if zoom gesture detection is enabled.
|
protected void |
onDraw(Canvas canvas)
Draw method should not be called until the view has dimensions so the first calls are used as triggers to calculate
the scaling and tiling required.
|
protected void |
onImageLoaded()
Called once when the full size image or its base layer tiles have been loaded.
|
protected void |
onMeasure(int widthMeasureSpec,
int heightMeasureSpec)
Measures the width and height of the view, preserving the aspect ratio of the image displayed if wrap_content is
used.
|
protected void |
onReady()
Called once when the view is initialised, has dimensions, and will display an image on the
next draw.
|
protected void |
onSizeChanged(int w,
int h,
int oldw,
int oldh)
On resize, preserve center and scale.
|
boolean |
onTouchEvent(MotionEvent event)
Handle touch events.
|
void |
recycle()
Releases all resources the view is using and resets the state, nulling any fields that use significant memory.
|
void |
resetScaleAndCenter()
Fully zoom out and return the image to the middle of the screen.
|
void |
setBitmapDecoderClass(Class<? extends ImageDecoder> bitmapDecoderClass)
Swap the default bitmap decoder implementation for one of your own.
|
void |
setBitmapDecoderFactory(DecoderFactory<? extends ImageDecoder> bitmapDecoderFactory)
Swap the default bitmap decoder implementation for one of your own.
|
void |
setDebug(boolean debug)
Enables visual debugging, showing tile boundaries and sizes.
|
void |
setDoubleTapZoomDpi(int dpi)
A density aware alternative to
setDoubleTapZoomScale(float); this allows you to express the scale the
image will zoom in to when double tapped in terms of the image pixel density. |
void |
setDoubleTapZoomDuration(int durationMs)
Set the duration of the double tap zoom animation.
|
void |
setDoubleTapZoomScale(float doubleTapZoomScale)
Set the scale the image will zoom in to when double tapped.
|
void |
setDoubleTapZoomStyle(int doubleTapZoomStyle)
Set the type of zoom animation to be used for double taps.
|
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.
|
void |
setExecutor(Executor executor)
Provide an
Executor to be used for loading images. |
void |
setImage(ImageSource imageSource)
Set the image source from a bitmap, resource, asset, file or other URI.
|
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.
|
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.
|
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.
|
void |
setMaximumDpi(int dpi)
This is a screen density aware alternative to
setMinScale(float); it allows you to express the minimum
allowed scale in terms of the maximum pixel density. |
void |
setMaxScale(float maxScale)
Set the maximum scale allowed.
|
void |
setMaxTileSize(int maxPixels)
By default the View automatically calculates the optimal tile size.
|
void |
setMaxTileSize(int maxPixelsX,
int maxPixelsY)
By default the View automatically calculates the optimal tile size.
|
void |
setMinimumDpi(int dpi)
This is a screen density aware alternative to
setMaxScale(float); it allows you to express the maximum
allowed scale in terms of the minimum pixel density. |
void |
setMinimumScaleType(int scaleType)
Set the minimum scale type.
|
void |
setMinimumTileDpi(int minimumTileDpi)
By default, image tiles are at least as high resolution as the screen.
|
void |
setMinScale(float minScale)
Set the minimum scale allowed.
|
void |
setOnImageEventListener(SubsamplingScaleImageView.OnImageEventListener onImageEventListener)
Add a listener allowing notification of load and error events.
|
void |
setOnLongClickListener(View.OnLongClickListener onLongClickListener) |
void |
setOnStateChangedListener(SubsamplingScaleImageView.OnStateChangedListener onStateChangedListener)
Add a listener for pan and zoom events.
|
void |
setOrientation(int orientation)
Sets the image orientation.
|
void |
setPanEnabled(boolean panEnabled)
Enable or disable pan gesture detection.
|
void |
setPanLimit(int panLimit)
Set the pan limiting style.
|
static void |
setPreferredBitmapConfig(Bitmap.Config preferredBitmapConfig)
Set a global preferred bitmap config shared by all view instances and applied to new instances
initialised after the call is made.
|
void |
setQuickScaleEnabled(boolean quickScaleEnabled)
Enable or disable double tap & swipe to zoom.
|
void |
setRegionDecoderClass(Class<? extends ImageRegionDecoder> regionDecoderClass)
Swap the default region decoder implementation for one of your own.
|
void |
setRegionDecoderFactory(DecoderFactory<? extends ImageRegionDecoder> regionDecoderFactory)
Swap the default region decoder implementation for one of your own.
|
void |
setScaleAndCenter(float scale,
PointF sCenter)
Externally change the scale and translation of the source image.
|
void |
setTileBackgroundColor(int tileBgColor)
Set a solid color to render behind tiles, useful for displaying transparent PNGs.
|
void |
setZoomEnabled(boolean zoomEnabled)
Enable or disable zoom gesture detection.
|
PointF |
sourceToViewCoord(float sx,
float sy)
Convert source coordinate to view coordinate.
|
PointF |
sourceToViewCoord(float sx,
float sy,
PointF vTarget)
Convert source coordinate to view coordinate.
|
PointF |
sourceToViewCoord(PointF sxy)
Convert source coordinate to view coordinate.
|
PointF |
sourceToViewCoord(PointF sxy,
PointF vTarget)
Convert source coordinate to view coordinate.
|
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.
|
PointF |
viewToSourceCoord(float vx,
float vy)
Convert screen coordinate to source coordinate.
|
PointF |
viewToSourceCoord(float vx,
float vy,
PointF sTarget)
Convert screen coordinate to source coordinate.
|
PointF |
viewToSourceCoord(PointF vxy)
Convert screen coordinate to source coordinate.
|
PointF |
viewToSourceCoord(PointF vxy,
PointF sTarget)
Convert screen coordinate to source coordinate.
|
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.
|
addChildrenForAccessibility, addExtraDataToAccessibilityNodeInfo, addFocusables, addFocusables, addKeyboardNavigationClusters, addOnAttachStateChangeListener, addOnLayoutChangeListener, addTouchables, animate, announceForAccessibility, autofill, autofill, awakenScrollBars, awakenScrollBars, awakenScrollBars, bringToFront, buildDrawingCache, buildDrawingCache, buildLayer, callOnClick, cancelDragAndDrop, cancelLongPress, cancelPendingInputEvents, canResolveLayoutDirection, canResolveTextAlignment, canResolveTextDirection, canScrollHorizontally, canScrollVertically, checkInputConnectionProxy, clearAnimation, clearFocus, combineMeasuredStates, computeHorizontalScrollExtent, computeHorizontalScrollOffset, computeHorizontalScrollRange, computeScroll, computeSystemWindowInsets, computeVerticalScrollExtent, computeVerticalScrollOffset, computeVerticalScrollRange, createAccessibilityNodeInfo, createContextMenu, destroyDrawingCache, dispatchApplyWindowInsets, dispatchCapturedPointerEvent, dispatchConfigurationChanged, dispatchDisplayHint, dispatchDragEvent, dispatchDraw, dispatchDrawableHotspotChanged, dispatchFinishTemporaryDetach, dispatchGenericFocusedEvent, dispatchGenericMotionEvent, dispatchGenericPointerEvent, dispatchHoverEvent, dispatchKeyEvent, dispatchKeyEventPreIme, dispatchKeyShortcutEvent, dispatchNestedFling, dispatchNestedPreFling, dispatchNestedPrePerformAccessibilityAction, dispatchNestedPreScroll, dispatchNestedScroll, dispatchPointerCaptureChanged, dispatchPopulateAccessibilityEvent, dispatchProvideAutofillStructure, dispatchProvideStructure, dispatchRestoreInstanceState, dispatchSaveInstanceState, dispatchSetActivated, dispatchSetPressed, dispatchSetSelected, dispatchStartTemporaryDetach, dispatchSystemUiVisibilityChanged, dispatchTouchEvent, dispatchTrackballEvent, dispatchUnhandledMove, dispatchVisibilityChanged, dispatchWindowFocusChanged, dispatchWindowSystemUiVisiblityChanged, dispatchWindowVisibilityChanged, draw, drawableHotspotChanged, drawableStateChanged, findFocus, findViewById, findViewsWithText, findViewWithTag, fitSystemWindows, focusSearch, forceHasOverlappingRendering, forceLayout, generateViewId, getAccessibilityClassName, getAccessibilityLiveRegion, getAccessibilityNodeProvider, getAccessibilityTraversalAfter, getAccessibilityTraversalBefore, getAlpha, getAnimation, getApplicationWindowToken, getAutofillHints, getAutofillId, getAutofillType, getAutofillValue, getBackground, getBackgroundTintList, getBackgroundTintMode, getBaseline, getBottom, getBottomFadingEdgeStrength, getBottomPaddingOffset, getCameraDistance, getClipBounds, getClipBounds, getClipToOutline, getContentDescription, getContext, getContextMenuInfo, getDefaultFocusHighlightEnabled, getDefaultSize, getDisplay, getDrawableState, getDrawingCache, getDrawingCache, getDrawingCacheBackgroundColor, getDrawingCacheQuality, getDrawingRect, getDrawingTime, getElevation, getFilterTouchesWhenObscured, getFitsSystemWindows, getFocusable, getFocusables, getFocusedRect, getForeground, getForegroundGravity, getForegroundTintList, getForegroundTintMode, getGlobalVisibleRect, getGlobalVisibleRect, getHandler, getHasOverlappingRendering, getHeight, getHitRect, getHorizontalFadingEdgeLength, getHorizontalScrollbarHeight, getId, getImportantForAccessibility, getImportantForAutofill, getKeepScreenOn, getKeyDispatcherState, getLabelFor, getLayerType, getLayoutDirection, getLayoutParams, getLeft, getLeftFadingEdgeStrength, getLeftPaddingOffset, getLocalVisibleRect, getLocationInWindow, getLocationOnScreen, getMatrix, getMeasuredHeight, getMeasuredHeightAndState, getMeasuredState, getMeasuredWidth, getMeasuredWidthAndState, getMinimumHeight, getMinimumWidth, getNextClusterForwardId, getNextFocusDownId, getNextFocusForwardId, getNextFocusLeftId, getNextFocusRightId, getNextFocusUpId, getOnFocusChangeListener, getOutlineProvider, getOverlay, getOverScrollMode, getPaddingBottom, getPaddingEnd, getPaddingLeft, getPaddingRight, getPaddingStart, getPaddingTop, getParent, getParentForAccessibility, getPivotX, getPivotY, getPointerIcon, getResources, getRevealOnFocusHint, getRight, getRightFadingEdgeStrength, getRightPaddingOffset, getRootView, getRootWindowInsets, getRotation, getRotationX, getRotationY, getScaleX, getScaleY, getScrollBarDefaultDelayBeforeFade, getScrollBarFadeDuration, getScrollBarSize, getScrollBarStyle, getScrollIndicators, getScrollX, getScrollY, getSolidColor, getStateListAnimator, getSuggestedMinimumHeight, getSuggestedMinimumWidth, getSystemUiVisibility, getTag, getTag, getTextAlignment, getTextDirection, getTooltipText, getTop, getTopFadingEdgeStrength, getTopPaddingOffset, getTouchables, getTouchDelegate, getTransitionName, getTranslationX, getTranslationY, getTranslationZ, getVerticalFadingEdgeLength, getVerticalScrollbarPosition, getVerticalScrollbarWidth, getViewTreeObserver, getVisibility, getWidth, getWindowAttachCount, getWindowId, getWindowSystemUiVisibility, getWindowToken, getWindowVisibility, getWindowVisibleDisplayFrame, getX, getY, getZ, hasExplicitFocusable, hasFocus, hasFocusable, hasNestedScrollingParent, hasOnClickListeners, hasOverlappingRendering, hasPointerCapture, hasTransientState, hasWindowFocus, inflate, invalidate, invalidate, invalidate, invalidateDrawable, invalidateOutline, isAccessibilityFocused, isActivated, isAttachedToWindow, isClickable, isContextClickable, isDirty, isDrawingCacheEnabled, isDuplicateParentStateEnabled, isEnabled, isFocusable, isFocusableInTouchMode, isFocused, isFocusedByDefault, isHapticFeedbackEnabled, isHardwareAccelerated, isHorizontalFadingEdgeEnabled, isHorizontalScrollBarEnabled, isHovered, isImportantForAccessibility, isImportantForAutofill, isInEditMode, isInLayout, isInTouchMode, isKeyboardNavigationCluster, isLaidOut, isLayoutDirectionResolved, isLayoutRequested, isLongClickable, isNestedScrollingEnabled, isOpaque, isPaddingOffsetRequired, isPaddingRelative, isPressed, isSaveEnabled, isSaveFromParentEnabled, isScrollbarFadingEnabled, isScrollContainer, isSelected, isShown, isSoundEffectsEnabled, isTemporarilyDetached, isTextAlignmentResolved, isTextDirectionResolved, isVerticalFadingEdgeEnabled, isVerticalScrollBarEnabled, jumpDrawablesToCurrentState, keyboardNavigationClusterSearch, layout, measure, mergeDrawableStates, offsetLeftAndRight, offsetTopAndBottom, onAnimationEnd, onAnimationStart, onApplyWindowInsets, onAttachedToWindow, onCancelPendingInputEvents, onCapturedPointerEvent, onCheckIsTextEditor, onConfigurationChanged, onCreateContextMenu, onCreateDrawableState, onCreateInputConnection, onDetachedFromWindow, onDisplayHint, onDragEvent, onDrawForeground, onDrawScrollBars, onFilterTouchEventForSecurity, onFinishInflate, onFinishTemporaryDetach, onFocusChanged, onGenericMotionEvent, onHoverChanged, onHoverEvent, onInitializeAccessibilityEvent, onInitializeAccessibilityNodeInfo, onKeyDown, onKeyLongPress, onKeyMultiple, onKeyPreIme, onKeyShortcut, onKeyUp, onLayout, onOverScrolled, onPointerCaptureChange, onPopulateAccessibilityEvent, onProvideAutofillStructure, onProvideAutofillVirtualStructure, onProvideStructure, onProvideVirtualStructure, onResolvePointerIcon, onRestoreInstanceState, onRtlPropertiesChanged, onSaveInstanceState, onScreenStateChanged, onScrollChanged, onSetAlpha, onStartTemporaryDetach, onTrackballEvent, onVisibilityAggregated, onVisibilityChanged, onWindowFocusChanged, onWindowSystemUiVisibilityChanged, onWindowVisibilityChanged, overScrollBy, performAccessibilityAction, performClick, performContextClick, performContextClick, performHapticFeedback, performHapticFeedback, performLongClick, performLongClick, playSoundEffect, post, postDelayed, postInvalidate, postInvalidate, postInvalidateDelayed, postInvalidateDelayed, postInvalidateOnAnimation, postInvalidateOnAnimation, postOnAnimation, postOnAnimationDelayed, refreshDrawableState, releasePointerCapture, removeCallbacks, removeOnAttachStateChangeListener, removeOnLayoutChangeListener, requestApplyInsets, requestFitSystemWindows, requestFocus, requestFocus, requestFocus, requestFocusFromTouch, requestLayout, requestPointerCapture, requestRectangleOnScreen, requestRectangleOnScreen, requestUnbufferedDispatch, resolveSize, resolveSizeAndState, restoreDefaultFocus, restoreHierarchyState, saveHierarchyState, scheduleDrawable, scrollBy, scrollTo, sendAccessibilityEvent, sendAccessibilityEventUnchecked, setAccessibilityDelegate, setAccessibilityLiveRegion, setAccessibilityTraversalAfter, setAccessibilityTraversalBefore, setActivated, setAlpha, setAnimation, setAutofillHints, setBackground, setBackgroundColor, setBackgroundDrawable, setBackgroundResource, setBackgroundTintList, setBackgroundTintMode, setBottom, setCameraDistance, setClickable, setClipBounds, setClipToOutline, setContentDescription, setContextClickable, setDefaultFocusHighlightEnabled, setDrawingCacheBackgroundColor, setDrawingCacheEnabled, setDrawingCacheQuality, setDuplicateParentStateEnabled, setElevation, setEnabled, setFadingEdgeLength, setFilterTouchesWhenObscured, setFitsSystemWindows, setFocusable, setFocusable, setFocusableInTouchMode, setFocusedByDefault, setForeground, setForegroundGravity, setForegroundTintList, setForegroundTintMode, setHapticFeedbackEnabled, setHasTransientState, setHorizontalFadingEdgeEnabled, setHorizontalScrollBarEnabled, setHovered, setId, setImportantForAccessibility, setImportantForAutofill, setKeepScreenOn, setKeyboardNavigationCluster, setLabelFor, setLayerPaint, setLayerType, setLayoutDirection, setLayoutParams, setLeft, setLongClickable, setMeasuredDimension, setMinimumHeight, setMinimumWidth, setNestedScrollingEnabled, setNextClusterForwardId, setNextFocusDownId, setNextFocusForwardId, setNextFocusLeftId, setNextFocusRightId, setNextFocusUpId, setOnApplyWindowInsetsListener, setOnCapturedPointerListener, setOnClickListener, setOnContextClickListener, setOnCreateContextMenuListener, setOnDragListener, setOnFocusChangeListener, setOnGenericMotionListener, setOnHoverListener, setOnKeyListener, setOnScrollChangeListener, setOnSystemUiVisibilityChangeListener, setOnTouchListener, setOutlineProvider, setOverScrollMode, setPadding, setPaddingRelative, setPivotX, setPivotY, setPointerIcon, setPressed, setRevealOnFocusHint, setRight, setRotation, setRotationX, setRotationY, setSaveEnabled, setSaveFromParentEnabled, setScaleX, setScaleY, setScrollBarDefaultDelayBeforeFade, setScrollBarFadeDuration, setScrollbarFadingEnabled, setScrollBarSize, setScrollBarStyle, setScrollContainer, setScrollIndicators, setScrollIndicators, setScrollX, setScrollY, setSelected, setSoundEffectsEnabled, setStateListAnimator, setSystemUiVisibility, setTag, setTag, setTextAlignment, setTextDirection, setTooltipText, setTop, setTouchDelegate, setTransitionName, setTranslationX, setTranslationY, setTranslationZ, setVerticalFadingEdgeEnabled, setVerticalScrollBarEnabled, setVerticalScrollbarPosition, setVisibility, setWillNotCacheDrawing, setWillNotDraw, setX, setY, setZ, showContextMenu, showContextMenu, startActionMode, startActionMode, startAnimation, startDrag, startDragAndDrop, startNestedScroll, stopNestedScroll, toString, unscheduleDrawable, unscheduleDrawable, updateDragShadow, verifyDrawable, willNotCacheDrawing, willNotDrawpublic static final int ORIENTATION_USE_EXIF
public static final int ORIENTATION_0
public static final int ORIENTATION_90
public static final int ORIENTATION_180
public static final int ORIENTATION_270
public static final int ZOOM_FOCUS_FIXED
public static final int ZOOM_FOCUS_CENTER
public static final int ZOOM_FOCUS_CENTER_IMMEDIATE
public static final int EASE_OUT_QUAD
public static final int EASE_IN_OUT_QUAD
public static final int PAN_LIMIT_INSIDE
public static final int PAN_LIMIT_OUTSIDE
public static final int PAN_LIMIT_CENTER
public static final int SCALE_TYPE_CENTER_INSIDE
public static final int SCALE_TYPE_CENTER_CROP
public static final int SCALE_TYPE_CUSTOM
public static final int SCALE_TYPE_START
public static final int ORIGIN_ANIM
public static final int ORIGIN_TOUCH
public static final int ORIGIN_FLING
public static final int ORIGIN_DOUBLE_TAP_ZOOM
public static final int TILE_SIZE_AUTO
public SubsamplingScaleImageView(Context context, AttributeSet attr)
public SubsamplingScaleImageView(Context context)
public static Bitmap.Config getPreferredBitmapConfig()
ImageDecoder and ImageRegionDecoder
instances can read this and use it when decoding images.public static void setPreferredBitmapConfig(Bitmap.Config preferredBitmapConfig)
ImageDecoder and
ImageRegionDecoder classes all respect this (except when they were constructed with
an instance-specific config) but custom decoder classes will not.preferredBitmapConfig - the bitmap configuration to be used by future instances of the view. Pass null to restore the default.public final void setOrientation(int orientation)
orientation - orientation to be set. See ORIENTATION_ static fields for valid values.public final void setImage(@NonNull ImageSource imageSource)
imageSource - Image source.public final void setImage(@NonNull ImageSource imageSource, ImageViewState state)
imageSource - Image source.state - State to be restored. Nullable.public final void setImage(@NonNull ImageSource imageSource, ImageSource previewSource)
ImageSource.dimensions(int, int)
on the imageSource object. The preview source will be ignored if you don't provide dimensions,
and if you provide a bitmap for the full size image.imageSource - Image source. Dimensions must be declared.previewSource - Optional source for a preview image to be displayed and allow interaction while the full size image loads.public final void setImage(@NonNull ImageSource imageSource, ImageSource previewSource, ImageViewState state)
ImageSource.dimensions(int, int)
on the imageSource object. The preview source will be ignored if you don't provide dimensions,
and if you provide a bitmap for the full size image.imageSource - Image source. Dimensions must be declared.previewSource - Optional source for a preview image to be displayed and allow interaction while the full size image loads.state - State to be restored. Nullable.protected void onSizeChanged(int w,
int h,
int oldw,
int oldh)
onSizeChanged in class Viewprotected void onMeasure(int widthMeasureSpec,
int heightMeasureSpec)
public boolean onTouchEvent(@NonNull MotionEvent event)
onTouchEvent in class Viewprotected void onDraw(Canvas canvas)
public void setMaxTileSize(int maxPixels)
TILE_SIZE_AUTO will re-enable the default behaviour.maxPixels - Maximum tile size X and Y in pixels.public void setMaxTileSize(int maxPixelsX,
int maxPixelsY)
TILE_SIZE_AUTO will re-enable the default behaviour.maxPixelsX - Maximum tile width.maxPixelsY - Maximum tile height.public void recycle()
public void viewToFileRect(Rect vRect, Rect fRect)
isReady() returns
true. It is not guaranteed to work with preloaded bitmaps.
The result is written to the fRect argument. Re-use a single instance for efficiency.vRect - rectangle representing the view area to interpret.fRect - rectangle instance to which the result will be written. Re-use for efficiency.public void visibleFileRect(Rect fRect)
viewToFileRect(Rect, Rect).fRect - rectangle instance to which the result will be written. Re-use for efficiency.@Nullable public final PointF viewToSourceCoord(PointF vxy)
vxy - view X/Y coordinate.@Nullable public final PointF viewToSourceCoord(float vx, float vy)
vx - view X coordinate.vy - view Y coordinate.@Nullable public final PointF viewToSourceCoord(PointF vxy, @NonNull PointF sTarget)
vxy - view coordinates to convert.sTarget - target object for result. The same instance is also returned.@Nullable public final PointF viewToSourceCoord(float vx, float vy, @NonNull PointF sTarget)
vx - view X coordinate.vy - view Y coordinate.sTarget - target object for result. The same instance is also returned.@Nullable public final PointF sourceToViewCoord(PointF sxy)
sxy - source coordinates to convert.@Nullable public final PointF sourceToViewCoord(float sx, float sy)
sx - source X coordinate.sy - source Y coordinate.@Nullable public final PointF sourceToViewCoord(PointF sxy, @NonNull PointF vTarget)
sxy - source coordinates to convert.vTarget - target object for result. The same instance is also returned.@Nullable public final PointF sourceToViewCoord(float sx, float sy, @NonNull PointF vTarget)
sx - source X coordinate.sy - source Y coordinate.vTarget - target object for result. The same instance is also returned.public final void setRegionDecoderClass(@NonNull Class<? extends ImageRegionDecoder> regionDecoderClass)
regionDecoderClass - The ImageRegionDecoder implementation to use.public final void setRegionDecoderFactory(@NonNull DecoderFactory<? extends ImageRegionDecoder> regionDecoderFactory)
regionDecoderFactory - The DecoderFactory implementation that produces ImageRegionDecoder
instances.public final void setBitmapDecoderClass(@NonNull Class<? extends ImageDecoder> bitmapDecoderClass)
bitmapDecoderClass - The ImageDecoder implementation to use.public final void setBitmapDecoderFactory(@NonNull DecoderFactory<? extends ImageDecoder> bitmapDecoderFactory)
bitmapDecoderFactory - The DecoderFactory implementation that produces ImageDecoder instances.public final void getPanRemaining(RectF vTarget)
RectF and expressed as screen pixels. For example, if the image cannot be
panned any further towards the left, the value of RectF.left will be set to 0.vTarget - target object for results. Re-use for efficiency.public final void setPanLimit(int panLimit)
PAN_LIMIT_INSIDE is best, for image galleries.panLimit - a pan limit constant. See static fields.public final void setMinimumScaleType(int scaleType)
SCALE_TYPE_CENTER_INSIDE is best, for image galleries.scaleType - a scale type constant. See static fields.public final void setMaxScale(float maxScale)
setMinimumDpi(int),
which is density aware.maxScale - maximum scale expressed as a source/view pixels ratio.public final void setMinScale(float minScale)
setMaximumDpi(int), which is density aware.minScale - minimum scale expressed as a source/view pixels ratio.public final void setMinimumDpi(int dpi)
setMaxScale(float); it allows you to express the maximum
allowed scale in terms of the minimum pixel density. This avoids the problem of 1:1 scale still being
too small on a high density screen. A sensible starting point is 160 - the default used by this view.dpi - Source image pixel density at maximum zoom.public final void setMaximumDpi(int dpi)
setMinScale(float); it allows you to express the minimum
allowed scale in terms of the maximum pixel density.dpi - Source image pixel density at minimum zoom.public float getMaxScale()
public final float getMinScale()
public void setMinimumTileDpi(int minimumTileDpi)
minimumTileDpi - Tile loading threshold.@Nullable public final PointF getCenter()
public final float getScale()
public final void setScaleAndCenter(float scale,
@Nullable
PointF sCenter)
scale - New scale to set.sCenter - New source image coordinate to center on the screen, subject to boundaries.public final void resetScaleAndCenter()
public final boolean isReady()
protected void onReady()
SubsamplingScaleImageView.OnImageEventListener.onReady() but
allows a subclass to receive this event without using a listener.public final boolean isImageLoaded()
protected void onImageLoaded()
public final int getSWidth()
getOrientation() returns 90 or 270, you can use getSHeight()
for the apparent width.public final int getSHeight()
getOrientation() returns 90 or 270, you can use getSWidth()
for the apparent height.public final int getOrientation()
ORIENTATION_USE_EXIF, in which case it doesn't tell you
the applied orientation of the image. For that, use getAppliedOrientation().public final int getAppliedOrientation()
@Nullable public final ImageViewState getState()
ImageViewState instance representing the current position of the image. null if the view isn't ready.public final boolean isZoomEnabled()
public final void setZoomEnabled(boolean zoomEnabled)
zoomEnabled - true to enable zoom gestures, false to disable.public final boolean isQuickScaleEnabled()
public final void setQuickScaleEnabled(boolean quickScaleEnabled)
quickScaleEnabled - true to enable quick scale, false to disable.public final boolean isPanEnabled()
public final void setPanEnabled(boolean panEnabled)
panEnabled - true to enable panning, false to disable.public final void setTileBackgroundColor(int tileBgColor)
tileBgColor - Background color for tiles.public final void setDoubleTapZoomScale(float doubleTapZoomScale)
doubleTapZoomScale - New value for double tap gesture zoom scale.public final void setDoubleTapZoomDpi(int dpi)
setDoubleTapZoomScale(float); this allows you to express the scale the
image will zoom in to when double tapped in terms of the image pixel density. Values lower than the max scale will
be ignored. A sensible starting point is 160 - the default used by this view.dpi - New value for double tap gesture zoom scale.public final void setDoubleTapZoomStyle(int doubleTapZoomStyle)
doubleTapZoomStyle - New value for zoom style.public final void setDoubleTapZoomDuration(int durationMs)
durationMs - Duration in milliseconds.public void setExecutor(@NonNull Executor executor)
Provide an Executor to be used for loading images. By default, AsyncTask.THREAD_POOL_EXECUTOR
is used to minimise contention with other background work the app is doing. You can also choose
to use AsyncTask.SERIAL_EXECUTOR if you want to limit concurrent background tasks.
Alternatively you can supply an Executor of your own to avoid any contention. It is
strongly recommended to use a single executor instance for the life of your application, not
one per view instance.
Warning: If you are using a custom implementation of ImageRegionDecoder, and you
supply an executor with more than one thread, you must make sure your implementation supports
multi-threaded bitmap decoding or has appropriate internal synchronization. From SDK 21, Android's
BitmapRegionDecoder uses an internal lock so it is thread safe but
there is no advantage to using multiple threads.
executor - an Executor for image loading.public void setEagerLoadingEnabled(boolean eagerLoadingEnabled)
eagerLoadingEnabled - true to enable loading during gestures, false to delay loading until gestures endpublic final void setDebug(boolean debug)
debug - true to enable debugging, false to disable.public boolean hasImage()
public void setOnLongClickListener(View.OnLongClickListener onLongClickListener)
setOnLongClickListener in class Viewpublic void setOnImageEventListener(SubsamplingScaleImageView.OnImageEventListener onImageEventListener)
SubsamplingScaleImageView.DefaultOnImageEventListener
to simplify implementation.onImageEventListener - an SubsamplingScaleImageView.OnImageEventListener instance.public void setOnStateChangedListener(SubsamplingScaleImageView.OnStateChangedListener onStateChangedListener)
SubsamplingScaleImageView.DefaultOnStateChangedListener to simplify
implementation.onStateChangedListener - an SubsamplingScaleImageView.OnStateChangedListener instance.@Nullable public SubsamplingScaleImageView.AnimationBuilder animateCenter(PointF sCenter)
sCenter - Target center pointSubsamplingScaleImageView.AnimationBuilder instance. Call SubsamplingScaleImageView.AnimationBuilder.start() to start the anim.@Nullable public SubsamplingScaleImageView.AnimationBuilder animateScale(float scale)
scale - Target scale.SubsamplingScaleImageView.AnimationBuilder instance. Call SubsamplingScaleImageView.AnimationBuilder.start() to start the anim.@Nullable public SubsamplingScaleImageView.AnimationBuilder animateScaleAndCenter(float scale, PointF sCenter)
scale - Target scale.sCenter - Target source center.SubsamplingScaleImageView.AnimationBuilder instance. Call SubsamplingScaleImageView.AnimationBuilder.start() to start the anim.T - The base type of the decoder this factory will produce.public class CompatDecoderFactory<T> extends Object implements DecoderFactory<T>
| Constructor and Description |
|---|
CompatDecoderFactory(Class<? extends T> clazz)
Construct a factory for the given class.
|
CompatDecoderFactory(Class<? extends T> clazz,
Bitmap.Config bitmapConfig)
Construct a factory for the given class.
|
public CompatDecoderFactory(@NonNull Class<? extends T> clazz)
clazz - a class that implements ImageDecoder or ImageRegionDecoder.public CompatDecoderFactory(@NonNull Class<? extends T> clazz, Bitmap.Config bitmapConfig)
Bitmap.Config instance.clazz - a class that implements ImageDecoder or ImageRegionDecoder.bitmapConfig - bitmap configuration to be used when loading images.@NonNull public T make() throws IllegalAccessException, InstantiationException, NoSuchMethodException, InvocationTargetException
DecoderFactoryT.make in interface DecoderFactory<T>IllegalAccessException - if the factory class cannot be instantiated.InstantiationException - if the factory class cannot be instantiated.NoSuchMethodException - if the factory class cannot be instantiated.InvocationTargetException - if the factory class cannot be instantiated.T - the class of decoder that will be produced.public interface DecoderFactory<T>
ImageDecoder and ImageRegionDecoder factories.| Modifier and Type | Method and Description |
|---|---|
T |
make()
Produce a new instance of a decoder with type
T. |
@NonNull T make() throws IllegalAccessException, InstantiationException, NoSuchMethodException, InvocationTargetException
T.IllegalAccessException - if the factory class cannot be instantiated.InstantiationException - if the factory class cannot be instantiated.NoSuchMethodException - if the factory class cannot be instantiated.InvocationTargetException - if the factory class cannot be instantiated.public interface ImageDecoder
BitmapFactory
based on the Skia library to be replaced with a custom class.| Modifier and Type | Method and Description |
|---|---|
Bitmap |
decode(Context context,
Uri uri)
Decode an image.
|
@NonNull Bitmap decode(Context context, @NonNull Uri uri) throws Exception
file:///scard/picture.jpg
file:///android_asset/picture.png
android.resource://com.example.app/drawable/picturecontext - Application contexturi - URI of the imageException - if decoding fails.public interface ImageRegionDecoder
BitmapRegionDecoder
based on the Skia library to be replaced with a custom class.| Modifier and Type | Method and Description |
|---|---|
Bitmap |
decodeRegion(Rect sRect,
int sampleSize)
Decode a region of the image with the given sample size.
|
Point |
init(Context context,
Uri uri)
Initialise the decoder.
|
boolean |
isReady()
Status check.
|
void |
recycle()
This method will be called when the decoder is no longer required.
|
@NonNull Point init(Context context, @NonNull Uri uri) throws Exception
file:///scard/picture.jpg
file:///android_asset/picture.png
android.resource://com.example.app/drawable/picturecontext - Application context. A reference may be held, but must be cleared on recycle.uri - URI of the image.Exception - if initialisation fails.@NonNull Bitmap decodeRegion(@NonNull Rect sRect, int sampleSize)
Decode a region of the image with the given sample size. This method is called off the UI
thread so it can safely load the image on the current thread. It is called from
AsyncTasks running in an executor that may have multiple threads, so
implementations must be thread safe. Adding synchronized to the method signature
is the simplest way to achieve this, but bear in mind the recycle() method can be
called concurrently.
See SkiaImageRegionDecoder and SkiaPooledImageRegionDecoder for examples of
internal locking and synchronization.
sRect - Source image rectangle to decode.sampleSize - Sample size.boolean isReady()
void recycle()
public class SkiaImageDecoder extends Object implements ImageDecoder
ImageDecoder
using Android's BitmapFactory, based on the Skia library. This
works well in most circumstances and has reasonable performance, however it has some problems
with grayscale, indexed and CMYK images.| Constructor and Description |
|---|
SkiaImageDecoder() |
SkiaImageDecoder(Bitmap.Config bitmapConfig) |
public SkiaImageDecoder()
public SkiaImageDecoder(@Nullable Bitmap.Config bitmapConfig)
@NonNull public Bitmap decode(Context context, @NonNull Uri uri) throws Exception
ImageDecoderfile:///scard/picture.jpg
file:///android_asset/picture.png
android.resource://com.example.app/drawable/picturedecode in interface ImageDecodercontext - Application contexturi - URI of the imageException - if decoding fails.public class SkiaImageRegionDecoder extends Object implements ImageRegionDecoder
ImageRegionDecoder
using Android's BitmapRegionDecoder, based on the Skia library. This
works well in most circumstances and has reasonable performance due to the cached decoder instance,
however it has some problems with grayscale, indexed and CMYK images.
A ReadWriteLock is used to delegate responsibility for multi threading behaviour to the
BitmapRegionDecoder instance on SDK >= 21, whilst allowing this class to block until no
tiles are being loaded before recycling the decoder. In practice, BitmapRegionDecoder is
synchronized internally so this has no real impact on performance.| Constructor and Description |
|---|
SkiaImageRegionDecoder() |
SkiaImageRegionDecoder(Bitmap.Config bitmapConfig) |
| Modifier and Type | Method and Description |
|---|---|
Bitmap |
decodeRegion(Rect sRect,
int sampleSize)
Decode a region of the image with the given sample size.
|
Point |
init(Context context,
Uri uri)
Initialise the decoder.
|
boolean |
isReady()
Status check.
|
void |
recycle()
This method will be called when the decoder is no longer required.
|
public SkiaImageRegionDecoder()
public SkiaImageRegionDecoder(@Nullable Bitmap.Config bitmapConfig)
@NonNull public Point init(Context context, @NonNull Uri uri) throws Exception
ImageRegionDecoderfile:///scard/picture.jpg
file:///android_asset/picture.png
android.resource://com.example.app/drawable/pictureinit in interface ImageRegionDecodercontext - Application context. A reference may be held, but must be cleared on recycle.uri - URI of the image.Exception - if initialisation fails.@NonNull public Bitmap decodeRegion(@NonNull Rect sRect, int sampleSize)
ImageRegionDecoder
Decode a region of the image with the given sample size. This method is called off the UI
thread so it can safely load the image on the current thread. It is called from
AsyncTasks running in an executor that may have multiple threads, so
implementations must be thread safe. Adding synchronized to the method signature
is the simplest way to achieve this, but bear in mind the ImageRegionDecoder.recycle() method can be
called concurrently.
See SkiaImageRegionDecoder and SkiaPooledImageRegionDecoder for examples of
internal locking and synchronization.
decodeRegion in interface ImageRegionDecodersRect - Source image rectangle to decode.sampleSize - Sample size.public boolean isReady()
ImageRegionDecoderisReady in interface ImageRegionDecoderpublic void recycle()
ImageRegionDecoderrecycle in interface ImageRegionDecoderpublic class SkiaPooledImageRegionDecoder extends Object implements ImageRegionDecoder
An implementation of ImageRegionDecoder using a pool of BitmapRegionDecoders,
to provide true parallel loading of tiles. This is only effective if parallel loading has been
enabled in the view by calling SubsamplingScaleImageView.setExecutor(Executor)
with a multi-threaded Executor instance.
One decoder is initialised when the class is initialised. This is enough to decode base layer tiles.
Additional decoders are initialised when a subregion of the image is first requested, which indicates
interaction with the view. Creation of additional encoders stops when allowAdditionalDecoder(int, long)
returns false. The default implementation takes into account the file size, number of CPU cores,
low memory status and a hard limit of 4. Extend this class to customise this.
WARNING: This class is highly experimental and not proven to be stable on a wide range of
devices. You are advised to test it thoroughly on all available devices, and code your app to use
SkiaImageRegionDecoder on old or low powered devices you could not test.
| Constructor and Description |
|---|
SkiaPooledImageRegionDecoder() |
SkiaPooledImageRegionDecoder(Bitmap.Config bitmapConfig) |
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
allowAdditionalDecoder(int numberOfDecoders,
long fileLength)
Called before creating a new decoder.
|
Bitmap |
decodeRegion(Rect sRect,
int sampleSize)
Acquire a read lock to prevent decoding overlapping with recycling, then check the pool still
exists and acquire a decoder to load the requested region.
|
Point |
init(Context context,
Uri uri)
Initialises the decoder pool.
|
boolean |
isReady()
Holding a read lock to avoid returning true while the pool is being recycled, this returns
true if the pool has at least one decoder available.
|
void |
recycle()
Wait until all read locks held by
decodeRegion(Rect, int) are released, then recycle
and destroy the pool. |
static void |
setDebug(boolean debug)
Controls logging of debug messages.
|
public SkiaPooledImageRegionDecoder()
public SkiaPooledImageRegionDecoder(@Nullable Bitmap.Config bitmapConfig)
public static void setDebug(boolean debug)
debug - true to enable debug logging, false to disable.@NonNull public Point init(Context context, @NonNull Uri uri) throws Exception
recycle() is called.init in interface ImageRegionDecodercontext - Application context. A reference may be held, but must be cleared on recycle.uri - URI of the image.Exception - if initialisation fails.@NonNull public Bitmap decodeRegion(@NonNull Rect sRect, int sampleSize)
init(Context, Uri)
is called and be null once recycle() is called. In practice the view can't call this
method until after init(Context, Uri), so there will be no blocking on an empty pool.decodeRegion in interface ImageRegionDecodersRect - Source image rectangle to decode.sampleSize - Sample size.public boolean isReady()
isReady in interface ImageRegionDecoderpublic void recycle()
decodeRegion(Rect, int) are released, then recycle
and destroy the pool. Elsewhere, when a read lock is acquired, we must check the pool is not null.recycle in interface ImageRegionDecoderprotected boolean allowAdditionalDecoder(int numberOfDecoders,
long fileLength)
numberOfDecoders - the number of decoders that have been created so farfileLength - the size of the image file in bytes. Creating another decoder will use approximately this much native memory.| Interface | Description |
|---|---|
| DecoderFactory<T> |
Interface for
ImageDecoder and ImageRegionDecoder factories. |
| ImageDecoder |
Interface for image decoding classes, allowing the default
BitmapFactory
based on the Skia library to be replaced with a custom class. |
| ImageRegionDecoder |
Interface for image decoding classes, allowing the default
BitmapRegionDecoder
based on the Skia library to be replaced with a custom class. |
| Class | Description |
|---|---|
| CompatDecoderFactory<T> |
Compatibility factory to instantiate decoders with empty public constructors.
|
| SkiaImageDecoder |
Default implementation of
ImageDecoder
using Android's BitmapFactory, based on the Skia library. |
| SkiaImageRegionDecoder |
Default implementation of
ImageRegionDecoder
using Android's BitmapRegionDecoder, based on the Skia library. |
| SkiaPooledImageRegionDecoder |
An implementation of
ImageRegionDecoder using a pool of BitmapRegionDecoders,
to provide true parallel loading of tiles. |
| Interface | Description |
|---|---|
| SubsamplingScaleImageView.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.
|
| SubsamplingScaleImageView.OnImageEventListener |
An event listener, allowing subclasses and activities to be notified of significant events.
|
| SubsamplingScaleImageView.OnStateChangedListener |
An event listener, allowing activities to be notified of pan and zoom events.
|
| Class | Description |
|---|---|
| ImageSource |
Helper class used to set the source and additional attributes from a variety of sources.
|
| ImageViewState |
Wraps the scale, center and orientation of a displayed image for easy restoration on screen rotate.
|
| SubsamplingScaleImageView |
Displays an image subsampled as necessary to avoid loading too much image data into memory.
|
| SubsamplingScaleImageView.DefaultOnAnimationEventListener |
Default implementation of
SubsamplingScaleImageView.OnAnimationEventListener for extension. |
| SubsamplingScaleImageView.DefaultOnImageEventListener |
Default implementation of
SubsamplingScaleImageView.OnImageEventListener for extension. |
| SubsamplingScaleImageView.DefaultOnStateChangedListener |
Default implementation of
SubsamplingScaleImageView.OnStateChangedListener. |
| Modifier and Type | Constant Field | Value |
|---|---|---|
public static final int |
EASE_IN_OUT_QUAD |
2 |
public static final int |
EASE_OUT_QUAD |
1 |
public static final int |
ORIENTATION_0 |
0 |
public static final int |
ORIENTATION_180 |
180 |
public static final int |
ORIENTATION_270 |
270 |
public static final int |
ORIENTATION_90 |
90 |
public static final int |
ORIENTATION_USE_EXIF |
-1 |
public static final int |
ORIGIN_ANIM |
1 |
public static final int |
ORIGIN_DOUBLE_TAP_ZOOM |
4 |
public static final int |
ORIGIN_FLING |
3 |
public static final int |
ORIGIN_TOUCH |
2 |
public static final int |
PAN_LIMIT_CENTER |
3 |
public static final int |
PAN_LIMIT_INSIDE |
1 |
public static final int |
PAN_LIMIT_OUTSIDE |
2 |
public static final int |
SCALE_TYPE_CENTER_CROP |
2 |
public static final int |
SCALE_TYPE_CENTER_INSIDE |
1 |
public static final int |
SCALE_TYPE_CUSTOM |
3 |
public static final int |
SCALE_TYPE_START |
4 |
public static final int |
TILE_SIZE_AUTO |
2147483647 |
public static final int |
ZOOM_FOCUS_CENTER |
2 |
public static final int |
ZOOM_FOCUS_CENTER_IMMEDIATE |
3 |
public static final int |
ZOOM_FOCUS_FIXED |
1 |
The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
Each annotation type has its own separate page with the following sections:
Each enum has its own separate page with the following sections:
There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
These links take you to the next or previous class, interface, package, or related page.
These links show and hide the HTML frames. All pages are available with or without frames.
The All Classes link shows all classes and interfaces except non-static nested types.
Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
The Constant Field Values page lists the static final fields and their values.
ImageDecoder and ImageRegionDecoder factories.BitmapFactory
based on the Skia library to be replaced with a custom class.BitmapRegionDecoder
based on the Skia library to be replaced with a custom class.T.decodeRegion(Rect, int) are released, then recycle
and destroy the pool.SubsamplingScaleImageView.setDoubleTapZoomScale(float); this allows you to express the scale the
image will zoom in to when double tapped in terms of the image pixel density.Executor to be used for loading images.SubsamplingScaleImageView.setMinScale(float); it allows you to express the minimum
allowed scale in terms of the maximum pixel density.SubsamplingScaleImageView.setMaxScale(float); it allows you to express the maximum
allowed scale in terms of the minimum pixel density.ImageDecoder
using Android's BitmapFactory, based on the Skia library.ImageRegionDecoder
using Android's BitmapRegionDecoder, based on the Skia library.ImageRegionDecoder using a pool of BitmapRegionDecoders,
to provide true parallel loading of tiles.SubsamplingScaleImageView.OnAnimationEventListener for extension.SubsamplingScaleImageView.OnImageEventListener for extension.SubsamplingScaleImageView.OnStateChangedListener.================================================ FILE: docs/javadoc/overview-summary.html ================================================
| Package | Description |
|---|---|
| com.davemorrissey.labs.subscaleview | |
| com.davemorrissey.labs.subscaleview.decoder |
float scale
float centerX
float centerY
int orientation
* Displays an image subsampled as necessary to avoid loading too much image data into memory. After zooming in, * a set of image tiles subsampled at higher resolution are loaded and displayed over the base layer. During pan 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 rotated and cropped source image pixels (scaled)
*
* f prefixes - coordinates, translations and distances measured in original unrotated, uncropped source file pixels
*
* Provide an {@link Executor} to be used for loading images. By default, {@link AsyncTask#THREAD_POOL_EXECUTOR} * is used to minimise contention with other background work the app is doing. You can also choose * to use {@link AsyncTask#SERIAL_EXECUTOR} if you want to limit concurrent background tasks. * Alternatively you can supply an {@link Executor} of your own to avoid any contention. It is * strongly recommended to use a single executor instance for the life of your application, not * one per view instance. *
* Warning: If you are using a custom implementation of {@link ImageRegionDecoder}, and you * supply an executor with more than one thread, you must make sure your implementation supports * multi-threaded bitmap decoding or has appropriate internal synchronization. From SDK 21, Android's * {@link android.graphics.BitmapRegionDecoder} uses an internal lock so it is thread safe but * there is no advantage to using multiple threads. *
* @param executor an {@link Executor} for image loading. */ public void setExecutor(@NonNull Executor executor) { //noinspection ConstantConditions if (executor == null) { throw new NullPointerException("Executor must not be null"); } this.executor = executor; } /** * Enable or disable eager loading of tiles that appear on screen during gestures or animations, * while the gesture or animation is still in progress. By default this is enabled to improve * responsiveness, but it can result in tiles being loaded and discarded more rapidly than * necessary and reduce the animation frame rate on old/cheap devices. Disable this on older * devices if you see poor performance. Tiles will then be loaded only when gestures and animations * are completed. * @param eagerLoadingEnabled true to enable loading during gestures, false to delay loading until gestures end */ public void setEagerLoadingEnabled(boolean eagerLoadingEnabled) { this.eagerLoadingEnabled = eagerLoadingEnabled; } /** * Enables visual debugging, showing tile boundaries and sizes. * @param debug true to enable debugging, false to disable. */ public final void setDebug(boolean debug) { this.debug = debug; } /** * Check if an image has been set. The image may not have been loaded and displayed yet. * @return If an image is currently set. */ public boolean hasImage() { return uri != null || bitmap != null; } /** * {@inheritDoc} */ @Override public void setOnLongClickListener(OnLongClickListener onLongClickListener) { this.onLongClickListener = onLongClickListener; } /** * Add a listener allowing notification of load and error events. Extend {@link DefaultOnImageEventListener} * to simplify implementation. * @param onImageEventListener an {@link OnImageEventListener} instance. */ public void setOnImageEventListener(OnImageEventListener onImageEventListener) { this.onImageEventListener = onImageEventListener; } /** * Add a listener for pan and zoom events. Extend {@link DefaultOnStateChangedListener} to simplify * implementation. * @param onStateChangedListener an {@link OnStateChangedListener} instance. */ public void setOnStateChangedListener(OnStateChangedListener onStateChangedListener) { this.onStateChangedListener = onStateChangedListener; } private void sendStateChanged(float oldScale, PointF oldVTranslate, int origin) { if (onStateChangedListener != null && scale != oldScale) { onStateChangedListener.onScaleChanged(scale, origin); } if (onStateChangedListener != null && !vTranslate.equals(oldVTranslate)) { onStateChangedListener.onCenterChanged(getCenter(), origin); } } /** * 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. If doing this would move the image beyond the edges of the screen, the * image is instead animated to move the center point as near to the center of the screen as is allowed - it's * guaranteed to be on screen. * @param sCenter Target center point * @return {@link AnimationBuilder} instance. Call {@link SubsamplingScaleImageView.AnimationBuilder#start()} to start the anim. */ @Nullable public AnimationBuilder animateCenter(PointF sCenter) { if (!isReady()) { return null; } return new AnimationBuilder(sCenter); } /** * Creates a scale animation builder, that when started will animate a zoom in or out. If this would move the image * beyond the panning limits, the image is automatically panned during the animation. * @param scale Target scale. * @return {@link AnimationBuilder} instance. Call {@link SubsamplingScaleImageView.AnimationBuilder#start()} to start the anim. */ @Nullable public AnimationBuilder animateScale(float scale) { if (!isReady()) { return null; } return new AnimationBuilder(scale); } /** * Creates a scale animation builder, that when started will animate a zoom in or out. If this would move the image * beyond the panning limits, the image is automatically panned during the animation. * @param scale Target scale. * @param sCenter Target source center. * @return {@link AnimationBuilder} instance. Call {@link SubsamplingScaleImageView.AnimationBuilder#start()} to start the anim. */ @Nullable public AnimationBuilder animateScaleAndCenter(float scale, PointF sCenter) { if (!isReady()) { return null; } return new AnimationBuilder(scale, sCenter); } /** * Builder class used to set additional options for a scale animation. Create an instance using {@link #animateScale(float)}, * then set your options and call {@link #start()}. */ public final class AnimationBuilder { private final float targetScale; private final PointF targetSCenter; private final PointF vFocus; private long duration = 500; private int easing = EASE_IN_OUT_QUAD; private int origin = ORIGIN_ANIM; private boolean interruptible = true; private boolean panLimited = true; private OnAnimationEventListener listener; private AnimationBuilder(PointF sCenter) { this.targetScale = scale; this.targetSCenter = sCenter; this.vFocus = null; } private AnimationBuilder(float scale) { this.targetScale = scale; this.targetSCenter = getCenter(); this.vFocus = null; } private AnimationBuilder(float scale, PointF sCenter) { this.targetScale = scale; this.targetSCenter = sCenter; this.vFocus = null; } private AnimationBuilder(float scale, PointF sCenter, PointF vFocus) { this.targetScale = scale; this.targetSCenter = sCenter; this.vFocus = vFocus; } /** * Desired duration of the anim in milliseconds. Default is 500. * @param duration duration in milliseconds. * @return this builder for method chaining. */ @NonNull public AnimationBuilder withDuration(long duration) { this.duration = duration; return this; } /** * Whether the animation can be interrupted with a touch. Default is true. * @param interruptible interruptible flag. * @return this builder for method chaining. */ @NonNull public AnimationBuilder withInterruptible(boolean interruptible) { this.interruptible = interruptible; return this; } /** * Set the easing style. See static fields. {@link #EASE_IN_OUT_QUAD} is recommended, and the default. * @param easing easing style. * @return this builder for method chaining. */ @NonNull public AnimationBuilder withEasing(int easing) { if (!VALID_EASING_STYLES.contains(easing)) { throw new IllegalArgumentException("Unknown easing type: " + easing); } this.easing = easing; return this; } /** * Add an animation event listener. * @param listener The listener. * @return this builder for method chaining. */ @NonNull public AnimationBuilder withOnAnimationEventListener(OnAnimationEventListener listener) { this.listener = listener; return this; } /** * Only for internal use. When set to true, the animation proceeds towards the actual end point - the nearest * point to the center allowed by pan limits. When false, animation is in the direction of the requested end * point and is stopped when the limit for each axis is reached. The latter behaviour is used for flings but * nothing else. */ @NonNull private AnimationBuilder withPanLimited(boolean panLimited) { this.panLimited = panLimited; return this; } /** * Only for internal use. Indicates what caused the animation. */ @NonNull private AnimationBuilder withOrigin(int origin) { this.origin = origin; return this; } /** * Starts the animation. */ public void start() { if (anim != null && anim.listener != null) { try { anim.listener.onInterruptedByNewAnim(); } catch (Exception e) { Log.w(TAG, "Error thrown by animation listener", e); } } int vxCenter = getPaddingLeft() + (getWidth() - getPaddingRight() - getPaddingLeft())/2; int vyCenter = getPaddingTop() + (getHeight() - getPaddingBottom() - getPaddingTop())/2; float targetScale = limitedScale(this.targetScale); PointF targetSCenter = panLimited ? limitedSCenter(this.targetSCenter.x, this.targetSCenter.y, targetScale, new PointF()) : this.targetSCenter; anim = new Anim(); anim.scaleStart = scale; anim.scaleEnd = targetScale; anim.time = System.currentTimeMillis(); anim.sCenterEndRequested = targetSCenter; anim.sCenterStart = getCenter(); anim.sCenterEnd = targetSCenter; anim.vFocusStart = sourceToViewCoord(targetSCenter); anim.vFocusEnd = new PointF( vxCenter, vyCenter ); anim.duration = duration; anim.interruptible = interruptible; anim.easing = easing; anim.origin = origin; anim.time = System.currentTimeMillis(); anim.listener = listener; if (vFocus != null) { // Calculate where translation will be at the end of the anim float vTranslateXEnd = vFocus.x - (targetScale * anim.sCenterStart.x); float vTranslateYEnd = vFocus.y - (targetScale * anim.sCenterStart.y); ScaleAndTranslate satEnd = new ScaleAndTranslate(targetScale, new PointF(vTranslateXEnd, vTranslateYEnd)); // Fit the end translation into bounds fitToBounds(true, satEnd); // Adjust the position of the focus point at end so image will be in bounds anim.vFocusEnd = new PointF( vFocus.x + (satEnd.vTranslate.x - vTranslateXEnd), vFocus.y + (satEnd.vTranslate.y - vTranslateYEnd) ); } invalidate(); } } /** * 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. Note that none of * these events are triggered if the activity is paused, the image is swapped, or in other cases * where the view's internal state gets wiped or draw events stop. */ @SuppressWarnings("EmptyMethod") public interface OnAnimationEventListener { /** * The animation has completed, having reached its endpoint. */ void onComplete(); /** * The animation has been aborted before reaching its endpoint because the user touched the screen. */ void onInterruptedByUser(); /** * The animation has been aborted before reaching its endpoint because a new animation has been started. */ void onInterruptedByNewAnim(); } /** * Default implementation of {@link OnAnimationEventListener} for extension. This does nothing in any method. */ public static class DefaultOnAnimationEventListener implements OnAnimationEventListener { @Override public void onComplete() { } @Override public void onInterruptedByUser() { } @Override public void onInterruptedByNewAnim() { } } /** * An event listener, allowing subclasses and activities to be notified of significant events. */ @SuppressWarnings("EmptyMethod") public interface OnImageEventListener { /** * Called when the dimensions of the image and view are known, and either a preview image, * the full size image, or base layer tiles are loaded. This indicates the scale and translate * are known and the next draw will display an image. This event can be used to hide a loading * graphic, or inform a subclass that it is safe to draw overlays. */ void onReady(); /** * Called when the full size image is ready. When using tiling, this means the lowest resolution * base layer of tiles are loaded, and when tiling is disabled, the image bitmap is loaded. * This event could be used as a trigger to enable gestures if you wanted interaction disabled * while only a preview is displayed, otherwise for most cases {@link #onReady()} is the best * event to listen to. */ void onImageLoaded(); /** * Called when a preview image could not be loaded. This method cannot be relied upon; certain * encoding types of supported image formats can result in corrupt or blank images being loaded * and displayed with no detectable error. The view will continue to load the full size image. * @param e The exception thrown. This error is logged by the view. */ void onPreviewLoadError(Exception e); /** * Indicates an error initiliasing the decoder when using a tiling, or when loading the full * size bitmap when tiling is disabled. This method cannot be relied upon; certain encoding * types of supported image formats can result in corrupt or blank images being loaded and * displayed with no detectable error. * @param e The exception thrown. This error is also logged by the view. */ void onImageLoadError(Exception e); /** * Called when an image tile could not be loaded. This method cannot be relied upon; certain * encoding types of supported image formats can result in corrupt or blank images being loaded * and displayed with no detectable error. Most cases where an unsupported file is used will * result in an error caught by {@link #onImageLoadError(Exception)}. * @param e The exception thrown. This error is logged by the view. */ void onTileLoadError(Exception e); /** * Called when a bitmap set using ImageSource.cachedBitmap is no longer being used by the View. * This is useful if you wish to manage the bitmap after the preview is shown */ void onPreviewReleased(); } /** * Default implementation of {@link OnImageEventListener} for extension. This does nothing in any method. */ public static class DefaultOnImageEventListener implements OnImageEventListener { @Override public void onReady() { } @Override public void onImageLoaded() { } @Override public void onPreviewLoadError(Exception e) { } @Override public void onImageLoadError(Exception e) { } @Override public void onTileLoadError(Exception e) { } @Override public void onPreviewReleased() { } } /** * An event listener, allowing activities to be notified of pan and zoom events. Initialisation * and calls made by your code do not trigger events; touch events and animations do. Methods in * this listener will be called on the UI thread and may be called very frequently - your * implementation should return quickly. */ @SuppressWarnings("EmptyMethod") public interface OnStateChangedListener { /** * The scale has changed. Use with {@link #getMaxScale()} and {@link #getMinScale()} to determine * whether the image is fully zoomed in or out. * @param newScale The new scale. * @param origin Where the event originated from - one of {@link #ORIGIN_ANIM}, {@link #ORIGIN_TOUCH}. */ void onScaleChanged(float newScale, int origin); /** * The source center has been changed. This can be a result of panning or zooming. * @param newCenter The new source center point. * @param origin Where the event originated from - one of {@link #ORIGIN_ANIM}, {@link #ORIGIN_TOUCH}. */ void onCenterChanged(PointF newCenter, int origin); } /** * Default implementation of {@link OnStateChangedListener}. This does nothing in any method. */ public static class DefaultOnStateChangedListener implements OnStateChangedListener { @Override public void onCenterChanged(PointF newCenter, int origin) { } @Override public void onScaleChanged(float newScale, int origin) { } } } ================================================ FILE: library/src/main/java/com/davemorrissey/labs/subscaleview/decoder/CompatDecoderFactory.java ================================================ package com.davemorrissey.labs.subscaleview.decoder; import android.graphics.Bitmap; import androidx.annotation.NonNull; import java.lang.reflect.Constructor; import java.lang.reflect.InvocationTargetException; /** * Compatibility factory to instantiate decoders with empty public constructors. * @paramfile:///scard/picture.jpg
* file:///android_asset/picture.png
* android.resource://com.example.app/drawable/picture
*
* @param context Application context
* @param uri URI of the image
* @return the decoded bitmap
* @throws Exception if decoding fails.
*/
@NonNull Bitmap decode(Context context, @NonNull Uri uri) throws Exception;
}
================================================
FILE: library/src/main/java/com/davemorrissey/labs/subscaleview/decoder/ImageRegionDecoder.java
================================================
package com.davemorrissey.labs.subscaleview.decoder;
import android.content.Context;
import android.graphics.Bitmap;
import android.graphics.Point;
import android.graphics.Rect;
import android.net.Uri;
import androidx.annotation.NonNull;
/**
* Interface for image decoding classes, allowing the default {@link android.graphics.BitmapRegionDecoder}
* based on the Skia library to be replaced with a custom class.
*/
public interface ImageRegionDecoder {
/**
* Initialise the decoder. When possible, perform initial setup work once in this method. The
* dimensions of the image must be returned. The URI can be in one of the following formats:
* file:///scard/picture.jpg
* file:///android_asset/picture.png
* android.resource://com.example.app/drawable/picture
* @param context Application context. A reference may be held, but must be cleared on recycle.
* @param uri URI of the image.
* @return Dimensions of the image.
* @throws Exception if initialisation fails.
*/
@NonNull Point init(Context context, @NonNull Uri uri) throws Exception;
/**
*
* Decode a region of the image with the given sample size. This method is called off the UI
* thread so it can safely load the image on the current thread. It is called from
* {@link android.os.AsyncTask}s running in an executor that may have multiple threads, so
* implementations must be thread safe. Adding synchronized to the method signature
* is the simplest way to achieve this, but bear in mind the {@link #recycle()} method can be
* called concurrently.
*
* See {@link SkiaImageRegionDecoder} and {@link SkiaPooledImageRegionDecoder} for examples of * internal locking and synchronization. *
* @param sRect Source image rectangle to decode. * @param sampleSize Sample size. * @return The decoded region. It is safe to return null if decoding fails. */ @NonNull Bitmap decodeRegion(@NonNull Rect sRect, int sampleSize); /** * Status check. Should return false before initialisation and after recycle. * @return true if the decoder is ready to be used. */ boolean isReady(); /** * This method will be called when the decoder is no longer required. It should clean up any resources still in use. */ void recycle(); } ================================================ FILE: library/src/main/java/com/davemorrissey/labs/subscaleview/decoder/SkiaImageDecoder.java ================================================ package com.davemorrissey.labs.subscaleview.decoder; import android.content.ContentResolver; import android.content.Context; import android.content.pm.PackageManager; import android.content.res.Resources; import android.graphics.Bitmap; import android.graphics.BitmapFactory; import android.net.Uri; import androidx.annotation.Keep; import androidx.annotation.NonNull; import androidx.annotation.Nullable; import android.text.TextUtils; import com.davemorrissey.labs.subscaleview.SubsamplingScaleImageView; import java.io.InputStream; import java.util.List; /** * Default implementation of {@link com.davemorrissey.labs.subscaleview.decoder.ImageDecoder} * using Android's {@link android.graphics.BitmapFactory}, based on the Skia library. This * works well in most circumstances and has reasonable performance, however it has some problems * with grayscale, indexed and CMYK images. */ public class SkiaImageDecoder implements ImageDecoder { private static final String FILE_PREFIX = "file://"; private static final String ASSET_PREFIX = FILE_PREFIX + "/android_asset/"; private static final String RESOURCE_PREFIX = ContentResolver.SCHEME_ANDROID_RESOURCE + "://"; private final Bitmap.Config bitmapConfig; @Keep @SuppressWarnings("unused") public SkiaImageDecoder() { this(null); } @SuppressWarnings({"WeakerAccess", "SameParameterValue"}) public SkiaImageDecoder(@Nullable Bitmap.Config bitmapConfig) { Bitmap.Config globalBitmapConfig = SubsamplingScaleImageView.getPreferredBitmapConfig(); if (bitmapConfig != null) { this.bitmapConfig = bitmapConfig; } else if (globalBitmapConfig != null) { this.bitmapConfig = globalBitmapConfig; } else { this.bitmapConfig = Bitmap.Config.RGB_565; } } @Override @NonNull public Bitmap decode(Context context, @NonNull Uri uri) throws Exception { String uriString = uri.toString(); BitmapFactory.Options options = new BitmapFactory.Options(); Bitmap bitmap; options.inPreferredConfig = bitmapConfig; if (uriString.startsWith(RESOURCE_PREFIX)) { Resources res; String packageName = uri.getAuthority(); if (context.getPackageName().equals(packageName)) { res = context.getResources(); } else { PackageManager pm = context.getPackageManager(); res = pm.getResourcesForApplication(packageName); } int id = 0; List* An implementation of {@link ImageRegionDecoder} using a pool of {@link BitmapRegionDecoder}s, * to provide true parallel loading of tiles. This is only effective if parallel loading has been * enabled in the view by calling {@link com.davemorrissey.labs.subscaleview.SubsamplingScaleImageView#setExecutor(Executor)} * with a multi-threaded {@link Executor} instance. *
* One decoder is initialised when the class is initialised. This is enough to decode base layer tiles. * Additional decoders are initialised when a subregion of the image is first requested, which indicates * interaction with the view. Creation of additional encoders stops when {@link #allowAdditionalDecoder(int, long)} * returns false. The default implementation takes into account the file size, number of CPU cores, * low memory status and a hard limit of 4. Extend this class to customise this. *
* WARNING: This class is highly experimental and not proven to be stable on a wide range of * devices. You are advised to test it thoroughly on all available devices, and code your app to use * {@link SkiaImageRegionDecoder} on old or low powered devices you could not test. *
*/ public class SkiaPooledImageRegionDecoder implements ImageRegionDecoder { private static final String TAG = SkiaPooledImageRegionDecoder.class.getSimpleName(); private static boolean debug = false; private DecoderPool decoderPool = new DecoderPool(); private final ReadWriteLock decoderLock = new ReentrantReadWriteLock(true); private static final String FILE_PREFIX = "file://"; private static final String ASSET_PREFIX = FILE_PREFIX + "/android_asset/"; private static final String RESOURCE_PREFIX = ContentResolver.SCHEME_ANDROID_RESOURCE + "://"; private final Bitmap.Config bitmapConfig; private Context context; private Uri uri; private long fileLength = Long.MAX_VALUE; private final Point imageDimensions = new Point(0, 0); private final AtomicBoolean lazyInited = new AtomicBoolean(false); @Keep @SuppressWarnings("unused") public SkiaPooledImageRegionDecoder() { this(null); } @SuppressWarnings({"WeakerAccess", "SameParameterValue"}) public SkiaPooledImageRegionDecoder(@Nullable Bitmap.Config bitmapConfig) { Bitmap.Config globalBitmapConfig = SubsamplingScaleImageView.getPreferredBitmapConfig(); if (bitmapConfig != null) { this.bitmapConfig = bitmapConfig; } else if (globalBitmapConfig != null) { this.bitmapConfig = globalBitmapConfig; } else { this.bitmapConfig = Bitmap.Config.RGB_565; } } /** * Controls logging of debug messages. All instances are affected. * @param debug true to enable debug logging, false to disable. */ @Keep @SuppressWarnings("unused") public static void setDebug(boolean debug) { SkiaPooledImageRegionDecoder.debug = debug; } /** * Initialises the decoder pool. This method creates one decoder on the current thread and uses * it to decode the bounds, then spawns an independent thread to populate the pool with an * additional three decoders. The thread will abort if {@link #recycle()} is called. */ @Override @NonNull public Point init(final Context context, @NonNull final Uri uri) throws Exception { this.context = context; this.uri = uri; initialiseDecoder(); return this.imageDimensions; } /** * Initialises extra decoders for as long as {@link #allowAdditionalDecoder(int, long)} returns * true and the pool has not been recycled. */ private void lazyInit() { if (lazyInited.compareAndSet(false, true) && fileLength < Long.MAX_VALUE) { debug("Starting lazy init of additional decoders"); Thread thread = new Thread() { @Override public void run() { while (decoderPool != null && allowAdditionalDecoder(decoderPool.size(), fileLength)) { // New decoders can be created while reading tiles but this read lock prevents // them being initialised while the pool is being recycled. try { if (decoderPool != null) { long start = System.currentTimeMillis(); debug("Starting decoder"); initialiseDecoder(); long end = System.currentTimeMillis(); debug("Started decoder, took " + (end - start) + "ms"); } } catch (Exception e) { // A decoder has already been successfully created so we can ignore this debug("Failed to start decoder: " + e.getMessage()); } } } }; thread.start(); } } /** * Initialises a new {@link BitmapRegionDecoder} and adds it to the pool, unless the pool has * been recycled while it was created. */ private void initialiseDecoder() throws Exception { String uriString = uri.toString(); BitmapRegionDecoder decoder; long fileLength = Long.MAX_VALUE; if (uriString.startsWith(RESOURCE_PREFIX)) { Resources res; String packageName = uri.getAuthority(); if (context.getPackageName().equals(packageName)) { res = context.getResources(); } else { PackageManager pm = context.getPackageManager(); res = pm.getResourcesForApplication(packageName); } int id = 0; List