com.theartofdev.edmodo.cropper

Class CropImageView

java.lang.Object

android.view.View

android.view.ViewGroup

android.widget.FrameLayout

com.theartofdev.edmodo.cropper.CropImageView

All Implemented Interfaces:

android.graphics.drawable.Drawable.Callback, android.view.accessibility.AccessibilityEventSource, android.view.KeyEvent.Callback, android.view.ViewManager, android.view.ViewParent

public class CropImageView
extends android.widget.FrameLayout

Custom view that provides cropping capabilities to an image.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CropImageView.CropShape The possible cropping area shape.
static interface	CropImageView.OnGetCroppedImageCompleteListener Interface definition for a callback to be invoked when image async cropping is complete.
static interface	CropImageView.OnSetImageUriCompleteListener Interface definition for a callback to be invoked when image async loading is complete.

Nested classes/interfaces inherited from class android.widget.FrameLayout

android.widget.FrameLayout.LayoutParams

Nested classes/interfaces inherited from class android.view.ViewGroup

android.view.ViewGroup.MarginLayoutParams, android.view.ViewGroup.OnHierarchyChangeListener

Nested classes/interfaces inherited from class android.view.View

android.view.View.AccessibilityDelegate, android.view.View.BaseSavedState, android.view.View.DragShadowBuilder, android.view.View.MeasureSpec, android.view.View.OnApplyWindowInsetsListener, android.view.View.OnAttachStateChangeListener, android.view.View.OnClickListener, android.view.View.OnContextClickListener, android.view.View.OnCreateContextMenuListener, android.view.View.OnDragListener, android.view.View.OnFocusChangeListener, android.view.View.OnGenericMotionListener, android.view.View.OnHoverListener, android.view.View.OnKeyListener, android.view.View.OnLayoutChangeListener, android.view.View.OnLongClickListener, android.view.View.OnScrollChangeListener, android.view.View.OnSystemUiVisibilityChangeListener, android.view.View.OnTouchListener

Field Summary

Fields inherited from class android.view.ViewGroup

CLIP_TO_PADDING_MASK, FOCUS_AFTER_DESCENDANTS, FOCUS_BEFORE_DESCENDANTS, FOCUS_BLOCK_DESCENDANTS, LAYOUT_MODE_CLIP_BOUNDS, LAYOUT_MODE_OPTICAL_BOUNDS, PERSISTENT_ALL_CACHES, PERSISTENT_ANIMATION_CACHE, PERSISTENT_NO_CACHE, PERSISTENT_SCROLLING_CACHE

Fields inherited from class android.view.View

ACCESSIBILITY_LIVE_REGION_ASSERTIVE, ACCESSIBILITY_LIVE_REGION_NONE, ACCESSIBILITY_LIVE_REGION_POLITE, ALPHA, 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, 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, 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, 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_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 Summary

Constructors

Constructor and Description
CropImageView(android.content.Context context)
CropImageView(android.content.Context context, android.util.AttributeSet attrs)

Method Summary

Modifier and Type	Method and Description
void	clearImage() Clear the current image set for cropping.
android.graphics.Rect	getActualCropRect() Gets the crop window's position relative to the source Bitmap (not the image displayed in the CropImageView).
android.graphics.Rect	getActualCropRectNoRotation() Gets the crop window's position relative to the source Bitmap (not the image displayed in the CropImageView) and the original rotation.
android.graphics.Bitmap	getCroppedImage() Gets the cropped image based on the current crop window.
android.graphics.Bitmap	getCroppedImage(int reqWidth, int reqHeight) Gets the cropped image based on the current crop window. If image loaded from URI will use sample size to fit in the requested width and height down-sampling if required - optimization to get best size to quality.
void	getCroppedImageAsync() Gets the cropped image based on the current crop window. The result will be invoked to listener set by setOnGetCroppedImageCompleteListener(OnGetCroppedImageCompleteListener).
void	getCroppedImageAsync(CropImageView.CropShape cropShape, int reqWidth, int reqHeight) Gets the cropped image based on the current crop window. If image loaded from URI will use sample size to fit in the requested width and height down-sampling if required - optimization to get best size to quality. The result will be invoked to listener set by setOnGetCroppedImageCompleteListener(OnGetCroppedImageCompleteListener).
android.graphics.Bitmap	getCroppedOvalImage() Gets the cropped circle image based on the current crop selection. Same as getCroppedImage() (as the bitmap is rectangular by nature) but the pixels beyond the oval crop will be transparent.
CropImageView.CropShape	getCropShape() The shape of the cropping area - rectangle/circular.
int	getImageResource() Returns the integer of the imageResource
android.net.Uri	getImageUri() Get the URI of an image that was set by URI, null otherwise.
android.widget.ImageView.ScaleType	getScaleType() Set the scale type of the image in the crop view
boolean	isShowProgressBar() if to show progress bar when image async loading/cropping is in progress. default: true, disable to provide custom progress bar UI.
protected void	onLayout(boolean changed, int l, int t, int r, int b)
protected void	onMeasure(int widthMeasureSpec, int heightMeasureSpec)
void	onRestoreInstanceState(android.os.Parcelable state)
android.os.Parcelable	onSaveInstanceState()
protected void	onSizeChanged(int w, int h, int oldw, int oldh)
void	rotateImage(int degrees) Rotates image by the specified number of degrees clockwise.
void	setAspectRatio(int aspectRatioX, int aspectRatioY) Sets the both the X and Y values of the aspectRatio.
void	setCropShape(CropImageView.CropShape cropShape) The shape of the cropping area - rectangle/circular.
void	setFixedAspectRatio(boolean fixAspectRatio) Sets whether the aspect ratio is fixed or not; true fixes the aspect ratio, while false allows it to be changed.
void	setGuidelines(int guidelines) Sets the guidelines for the CropOverlayView to be either on, off, or to show when resizing the application.
void	setImageBitmap(android.graphics.Bitmap bitmap) Sets a Bitmap as the content of the CropImageView.
void	setImageBitmap(android.graphics.Bitmap bitmap, android.media.ExifInterface exif) Sets a Bitmap and initializes the image rotation according to the EXIT data. The EXIF can be retrieved by doing the following: ExifInterface exif = new ExifInterface(path);
void	setImageResource(int resId) Sets a Drawable as the content of the CropImageView.
void	setImageUri(android.net.Uri uri) Deprecated. Use setImageUriAsync(Uri) for better async handling
void	setImageUriAsync(android.net.Uri uri) Sets a bitmap loaded from the given Android URI as the content of the CropImageView. Can be used with URI from gallery or camera source. Will rotate the image by exif data.
void	setOnGetCroppedImageCompleteListener(CropImageView.OnGetCroppedImageCompleteListener listener) Set the callback to be invoked when image async cropping (getCroppedImageAsync()) is complete (successful or failed).
void	setOnSetImageUriCompleteListener(CropImageView.OnSetImageUriCompleteListener listener) Set the callback to be invoked when image async loading (setImageUriAsync(Uri)) is complete (successful or failed).
void	setScaleType(android.widget.ImageView.ScaleType scaleType) Set the scale type of the image in the crop view
void	setShowProgressBar(boolean showProgressBar) if to show progress bar when image async loading/cropping is in progress. default: true, disable to provide custom progress bar UI.
void	setSnapRadius(float snapRadius) An edge of the crop window will snap to the corresponding edge of a specified bounding box when the crop window edge is less than or equal to this distance (in pixels) away from the bounding box edge.

Methods inherited from class android.widget.FrameLayout

checkLayoutParams, generateDefaultLayoutParams, generateLayoutParams, generateLayoutParams, getAccessibilityClassName, getConsiderGoneChildrenWhenMeasuring, getMeasureAllChildren, setForegroundGravity, setMeasureAllChildren, shouldDelayChildPressedState

Methods inherited from class android.view.ViewGroup

addChildrenForAccessibility, addFocusables, addStatesFromChildren, addTouchables, addView, addView, addView, addView, addView, addViewInLayout, addViewInLayout, attachLayoutAnimationParameters, attachViewToParent, bringChildToFront, canAnimate, childDrawableStateChanged, childHasTransientStateChanged, cleanupLayoutState, clearChildFocus, clearDisappearingChildren, clearFocus, debug, detachAllViewsFromParent, detachViewFromParent, detachViewFromParent, detachViewsFromParent, dispatchApplyWindowInsets, dispatchConfigurationChanged, dispatchDisplayHint, dispatchDragEvent, dispatchDraw, dispatchDrawableHotspotChanged, dispatchFreezeSelfOnly, dispatchGenericFocusedEvent, dispatchGenericPointerEvent, dispatchHoverEvent, dispatchKeyEvent, dispatchKeyEventPreIme, dispatchKeyShortcutEvent, dispatchProvideStructure, dispatchRestoreInstanceState, dispatchSaveInstanceState, dispatchSetActivated, dispatchSetPressed, dispatchSetSelected, dispatchSystemUiVisibilityChanged, dispatchThawSelfOnly, dispatchTouchEvent, dispatchTrackballEvent, dispatchUnhandledMove, dispatchVisibilityChanged, dispatchWindowFocusChanged, dispatchWindowSystemUiVisiblityChanged, dispatchWindowVisibilityChanged, drawableStateChanged, drawChild, endViewTransition, findFocus, findViewsWithText, focusableViewAvailable, focusSearch, gatherTransparentRegion, getChildAt, getChildCount, getChildDrawingOrder, getChildMeasureSpec, getChildStaticTransformation, getChildVisibleRect, getClipChildren, getClipToPadding, getDescendantFocusability, getFocusedChild, getLayoutAnimation, getLayoutAnimationListener, getLayoutMode, getLayoutTransition, getNestedScrollAxes, getOverlay, getPersistentDrawingCache, getTouchscreenBlocksFocus, hasFocus, hasFocusable, hasTransientState, indexOfChild, invalidateChild, invalidateChildInParent, isAlwaysDrawnWithCacheEnabled, isAnimationCacheEnabled, isChildrenDrawingOrderEnabled, isChildrenDrawnWithCacheEnabled, isMotionEventSplittingEnabled, isTransitionGroup, jumpDrawablesToCurrentState, layout, measureChild, measureChildren, measureChildWithMargins, notifySubtreeAccessibilityStateChanged, offsetDescendantRectToMyCoords, offsetRectIntoDescendantCoords, onAttachedToWindow, onCreateDrawableState, onDetachedFromWindow, onInterceptHoverEvent, onInterceptTouchEvent, onNestedFling, onNestedPreFling, onNestedPrePerformAccessibilityAction, onNestedPreScroll, onNestedScroll, onNestedScrollAccepted, onRequestFocusInDescendants, onRequestSendAccessibilityEvent, onStartNestedScroll, onStopNestedScroll, onViewAdded, onViewRemoved, recomputeViewAttributes, removeAllViews, removeAllViewsInLayout, removeDetachedView, removeView, removeViewAt, removeViewInLayout, removeViews, removeViewsInLayout, requestChildFocus, requestChildRectangleOnScreen, requestDisallowInterceptTouchEvent, requestFocus, requestSendAccessibilityEvent, requestTransparentRegion, scheduleLayoutAnimation, setAddStatesFromChildren, setAlwaysDrawnWithCacheEnabled, setAnimationCacheEnabled, setChildrenDrawingCacheEnabled, setChildrenDrawingOrderEnabled, setChildrenDrawnWithCacheEnabled, setClipChildren, setClipToPadding, setDescendantFocusability, setLayoutAnimation, setLayoutAnimationListener, setLayoutMode, setLayoutTransition, setMotionEventSplittingEnabled, setOnHierarchyChangeListener, setPersistentDrawingCache, setStaticTransformationsEnabled, setTouchscreenBlocksFocus, setTransitionGroup, showContextMenuForChild, startActionModeForChild, startActionModeForChild, startLayoutAnimation, startViewTransition, updateViewLayout

Methods inherited from class android.view.View

addFocusables, addOnAttachStateChangeListener, addOnLayoutChangeListener, animate, announceForAccessibility, awakenScrollBars, awakenScrollBars, awakenScrollBars, bringToFront, buildDrawingCache, buildDrawingCache, buildLayer, callOnClick, cancelLongPress, cancelPendingInputEvents, canResolveLayoutDirection, canResolveTextAlignment, canResolveTextDirection, canScrollHorizontally, canScrollVertically, checkInputConnectionProxy, clearAnimation, combineMeasuredStates, computeHorizontalScrollExtent, computeHorizontalScrollOffset, computeHorizontalScrollRange, computeScroll, computeSystemWindowInsets, computeVerticalScrollExtent, computeVerticalScrollOffset, computeVerticalScrollRange, createAccessibilityNodeInfo, createContextMenu, destroyDrawingCache, dispatchGenericMotionEvent, dispatchNestedFling, dispatchNestedPreFling, dispatchNestedPrePerformAccessibilityAction, dispatchNestedPreScroll, dispatchNestedScroll, dispatchPopulateAccessibilityEvent, draw, drawableHotspotChanged, findViewById, findViewWithTag, fitSystemWindows, focusSearch, forceLayout, generateViewId, getAccessibilityLiveRegion, getAccessibilityNodeProvider, getAccessibilityTraversalAfter, getAccessibilityTraversalBefore, getAlpha, getAnimation, getApplicationWindowToken, getBackground, getBackgroundTintList, getBackgroundTintMode, getBaseline, getBottom, getBottomFadingEdgeStrength, getBottomPaddingOffset, getCameraDistance, getClipBounds, getClipBounds, getClipToOutline, getContentDescription, getContext, getContextMenuInfo, getDefaultSize, getDisplay, getDrawableState, getDrawingCache, getDrawingCache, getDrawingCacheBackgroundColor, getDrawingCacheQuality, getDrawingRect, getDrawingTime, getElevation, getFilterTouchesWhenObscured, getFitsSystemWindows, getFocusables, getFocusedRect, getForeground, getForegroundGravity, getForegroundTintList, getForegroundTintMode, getGlobalVisibleRect, getGlobalVisibleRect, getHandler, getHeight, getHitRect, getHorizontalFadingEdgeLength, getHorizontalScrollbarHeight, getId, getImportantForAccessibility, getKeepScreenOn, getKeyDispatcherState, getLabelFor, getLayerType, getLayoutDirection, getLayoutParams, getLeft, getLeftFadingEdgeStrength, getLeftPaddingOffset, getLocalVisibleRect, getLocationInWindow, getLocationOnScreen, getMatrix, getMeasuredHeight, getMeasuredHeightAndState, getMeasuredState, getMeasuredWidth, getMeasuredWidthAndState, getMinimumHeight, getMinimumWidth, getNextFocusDownId, getNextFocusForwardId, getNextFocusLeftId, getNextFocusRightId, getNextFocusUpId, getOnFocusChangeListener, getOutlineProvider, getOverScrollMode, getPaddingBottom, getPaddingEnd, getPaddingLeft, getPaddingRight, getPaddingStart, getPaddingTop, getParent, getParentForAccessibility, getPivotX, getPivotY, getResources, 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, getTop, getTopFadingEdgeStrength, getTopPaddingOffset, getTouchables, getTouchDelegate, getTransitionName, getTranslationX, getTranslationY, getTranslationZ, getVerticalFadingEdgeLength, getVerticalScrollbarPosition, getVerticalScrollbarWidth, getViewTreeObserver, getVisibility, getWidth, getWindowAttachCount, getWindowId, getWindowSystemUiVisibility, getWindowToken, getWindowVisibility, getWindowVisibleDisplayFrame, getX, getY, getZ, hasNestedScrollingParent, hasOnClickListeners, hasOverlappingRendering, hasWindowFocus, inflate, invalidate, invalidate, invalidate, invalidateDrawable, invalidateOutline, isAccessibilityFocused, isActivated, isAttachedToWindow, isClickable, isContextClickable, isDirty, isDrawingCacheEnabled, isDuplicateParentStateEnabled, isEnabled, isFocusable, isFocusableInTouchMode, isFocused, isHapticFeedbackEnabled, isHardwareAccelerated, isHorizontalFadingEdgeEnabled, isHorizontalScrollBarEnabled, isHovered, isImportantForAccessibility, isInEditMode, isInLayout, isInTouchMode, isLaidOut, isLayoutDirectionResolved, isLayoutRequested, isLongClickable, isNestedScrollingEnabled, isOpaque, isPaddingOffsetRequired, isPaddingRelative, isPressed, isSaveEnabled, isSaveFromParentEnabled, isScrollbarFadingEnabled, isScrollContainer, isSelected, isShown, isSoundEffectsEnabled, isTextAlignmentResolved, isTextDirectionResolved, isVerticalFadingEdgeEnabled, isVerticalScrollBarEnabled, measure, mergeDrawableStates, offsetLeftAndRight, offsetTopAndBottom, onAnimationEnd, onAnimationStart, onApplyWindowInsets, onCancelPendingInputEvents, onCheckIsTextEditor, onConfigurationChanged, onCreateContextMenu, onCreateInputConnection, onDisplayHint, onDragEvent, onDraw, onDrawForeground, onDrawScrollBars, onFilterTouchEventForSecurity, onFinishInflate, onFinishTemporaryDetach, onFocusChanged, onGenericMotionEvent, onHoverChanged, onHoverEvent, onInitializeAccessibilityEvent, onInitializeAccessibilityNodeInfo, onKeyDown, onKeyLongPress, onKeyMultiple, onKeyPreIme, onKeyShortcut, onKeyUp, onOverScrolled, onPopulateAccessibilityEvent, onProvideStructure, onProvideVirtualStructure, onRtlPropertiesChanged, onScreenStateChanged, onScrollChanged, onSetAlpha, onStartTemporaryDetach, onTouchEvent, onTrackballEvent, onVisibilityChanged, onWindowFocusChanged, onWindowSystemUiVisibilityChanged, onWindowVisibilityChanged, overScrollBy, performAccessibilityAction, performClick, performContextClick, performHapticFeedback, performHapticFeedback, performLongClick, playSoundEffect, post, postDelayed, postInvalidate, postInvalidate, postInvalidateDelayed, postInvalidateDelayed, postInvalidateOnAnimation, postInvalidateOnAnimation, postOnAnimation, postOnAnimationDelayed, refreshDrawableState, removeCallbacks, removeOnAttachStateChangeListener, removeOnLayoutChangeListener, requestApplyInsets, requestFitSystemWindows, requestFocus, requestFocus, requestFocusFromTouch, requestLayout, requestRectangleOnScreen, requestRectangleOnScreen, requestUnbufferedDispatch, resolveSize, resolveSizeAndState, restoreHierarchyState, saveHierarchyState, scheduleDrawable, scrollBy, scrollTo, sendAccessibilityEvent, sendAccessibilityEventUnchecked, setAccessibilityDelegate, setAccessibilityLiveRegion, setAccessibilityTraversalAfter, setAccessibilityTraversalBefore, setActivated, setAlpha, setAnimation, setBackground, setBackgroundColor, setBackgroundDrawable, setBackgroundResource, setBackgroundTintList, setBackgroundTintMode, setBottom, setCameraDistance, setClickable, setClipBounds, setClipToOutline, setContentDescription, setContextClickable, setDrawingCacheBackgroundColor, setDrawingCacheEnabled, setDrawingCacheQuality, setDuplicateParentStateEnabled, setElevation, setEnabled, setFadingEdgeLength, setFilterTouchesWhenObscured, setFitsSystemWindows, setFocusable, setFocusableInTouchMode, setForeground, setForegroundTintList, setForegroundTintMode, setHapticFeedbackEnabled, setHasTransientState, setHorizontalFadingEdgeEnabled, setHorizontalScrollBarEnabled, setHovered, setId, setImportantForAccessibility, setKeepScreenOn, setLabelFor, setLayerPaint, setLayerType, setLayoutDirection, setLayoutParams, setLeft, setLongClickable, setMeasuredDimension, setMinimumHeight, setMinimumWidth, setNestedScrollingEnabled, setNextFocusDownId, setNextFocusForwardId, setNextFocusLeftId, setNextFocusRightId, setNextFocusUpId, setOnApplyWindowInsetsListener, setOnClickListener, setOnContextClickListener, setOnCreateContextMenuListener, setOnDragListener, setOnFocusChangeListener, setOnGenericMotionListener, setOnHoverListener, setOnKeyListener, setOnLongClickListener, setOnScrollChangeListener, setOnSystemUiVisibilityChangeListener, setOnTouchListener, setOutlineProvider, setOverScrollMode, setPadding, setPaddingRelative, setPivotX, setPivotY, setPressed, 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, setTop, setTouchDelegate, setTransitionName, setTranslationX, setTranslationY, setTranslationZ, setVerticalFadingEdgeEnabled, setVerticalScrollBarEnabled, setVerticalScrollbarPosition, setVisibility, setWillNotCacheDrawing, setWillNotDraw, setX, setY, setZ, showContextMenu, startActionMode, startActionMode, startAnimation, startDrag, startNestedScroll, stopNestedScroll, toString, unscheduleDrawable, unscheduleDrawable, verifyDrawable, willNotCacheDrawing, willNotDraw

Methods inherited from class java.lang.Object

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

Methods inherited from interface android.view.ViewParent

canResolveLayoutDirection, canResolveTextAlignment, canResolveTextDirection, createContextMenu, getLayoutDirection, getParent, getParentForAccessibility, getTextAlignment, getTextDirection, isLayoutDirectionResolved, isLayoutRequested, isTextAlignmentResolved, isTextDirectionResolved, requestFitSystemWindows, requestLayout

Constructor Detail

CropImageView

public CropImageView(android.content.Context context)

CropImageView

public CropImageView(android.content.Context context,
                     android.util.AttributeSet attrs)

Method Detail

getScaleType

public android.widget.ImageView.ScaleType getScaleType()

Set the scale type of the image in the crop view

setScaleType

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

Set the scale type of the image in the crop view

getCropShape

public CropImageView.CropShape getCropShape()

The shape of the cropping area - rectangle/circular.

setCropShape

public void setCropShape(CropImageView.CropShape cropShape)

The shape of the cropping area - rectangle/circular.

setFixedAspectRatio

public void setFixedAspectRatio(boolean fixAspectRatio)

Sets whether the aspect ratio is fixed or not; true fixes the aspect ratio, while false allows it to be changed.

Parameters:

fixAspectRatio - Boolean that signals whether the aspect ratio should be maintained.

setGuidelines

public void setGuidelines(int guidelines)

Sets the guidelines for the CropOverlayView to be either on, off, or to show when resizing the application.

Parameters:

guidelines - Integer that signals whether the guidelines should be on, off, or only showing when resizing.

setAspectRatio

public void setAspectRatio(int aspectRatioX,
                           int aspectRatioY)

Sets the both the X and Y values of the aspectRatio.

Parameters:

aspectRatioX - int that specifies the new X value of the aspect ratio

aspectRatioY - int that specifies the new Y value of the aspect ratio

setSnapRadius

public void setSnapRadius(float snapRadius)

An edge of the crop window will snap to the corresponding edge of a specified bounding box when the crop window edge is less than or equal to this distance (in pixels) away from the bounding box edge. (default: 3)

isShowProgressBar

public boolean isShowProgressBar()

if to show progress bar when image async loading/cropping is in progress.
default: true, disable to provide custom progress bar UI.

setShowProgressBar

public void setShowProgressBar(boolean showProgressBar)

if to show progress bar when image async loading/cropping is in progress.
default: true, disable to provide custom progress bar UI.

getImageResource

public int getImageResource()

Returns the integer of the imageResource

getImageUri

public android.net.Uri getImageUri()

Get the URI of an image that was set by URI, null otherwise.

getActualCropRect

public android.graphics.Rect getActualCropRect()

Gets the crop window's position relative to the source Bitmap (not the image displayed in the CropImageView).

Returns:

a RectF instance containing cropped area boundaries of the source Bitmap

getActualCropRectNoRotation

public android.graphics.Rect getActualCropRectNoRotation()

Gets the crop window's position relative to the source Bitmap (not the image displayed in the CropImageView) and the original rotation.

Returns:

a RectF instance containing cropped area boundaries of the source Bitmap

getCroppedImage

public android.graphics.Bitmap getCroppedImage()

Gets the cropped image based on the current crop window.

Returns:

a new Bitmap representing the cropped image

getCroppedImage

public android.graphics.Bitmap getCroppedImage(int reqWidth,
                                               int reqHeight)

Gets the cropped image based on the current crop window.
If image loaded from URI will use sample size to fit in the requested width and height down-sampling if required - optimization to get best size to quality.

Returns:

a new Bitmap representing the cropped image

getCroppedOvalImage

public android.graphics.Bitmap getCroppedOvalImage()

Gets the cropped circle image based on the current crop selection.
Same as getCroppedImage() (as the bitmap is rectangular by nature) but the pixels beyond the oval crop will be transparent.

Returns:

a new Circular Bitmap representing the cropped image

getCroppedImageAsync

public void getCroppedImageAsync()

Gets the cropped image based on the current crop window.
The result will be invoked to listener set by setOnGetCroppedImageCompleteListener(OnGetCroppedImageCompleteListener).

getCroppedImageAsync

public void getCroppedImageAsync(CropImageView.CropShape cropShape,
                                 int reqWidth,
                                 int reqHeight)

Gets the cropped image based on the current crop window.
If image loaded from URI will use sample size to fit in the requested width and height down-sampling if required - optimization to get best size to quality.
The result will be invoked to listener set by setOnGetCroppedImageCompleteListener(OnGetCroppedImageCompleteListener).

Parameters:

cropShape - the shape to crop the image

setOnSetImageUriCompleteListener

public void setOnSetImageUriCompleteListener(CropImageView.OnSetImageUriCompleteListener listener)

Set the callback to be invoked when image async loading (setImageUriAsync(Uri)) is complete (successful or failed).

setOnGetCroppedImageCompleteListener

public void setOnGetCroppedImageCompleteListener(CropImageView.OnGetCroppedImageCompleteListener listener)

Set the callback to be invoked when image async cropping (getCroppedImageAsync()) is complete (successful or failed).

setImageBitmap

public void setImageBitmap(android.graphics.Bitmap bitmap)

Sets a Bitmap as the content of the CropImageView.

Parameters:

bitmap - the Bitmap to set

setImageBitmap

public void setImageBitmap(android.graphics.Bitmap bitmap,
                           android.media.ExifInterface exif)

Sets a Bitmap and initializes the image rotation according to the EXIT data.

The EXIF can be retrieved by doing the following: ExifInterface exif = new ExifInterface(path);

Parameters:

bitmap - the original bitmap to set; if null, this

exif - the EXIF information about this bitmap; may be null

setImageResource

public void setImageResource(int resId)

Sets a Drawable as the content of the CropImageView.

Parameters:

resId - the drawable resource ID to set

setImageUri

@Deprecated
public void setImageUri(android.net.Uri uri)

Deprecated. Use setImageUriAsync(Uri) for better async handling

Sets a bitmap loaded from the given Android URI as the content of the CropImageView.
Can be used with URI from gallery or camera source.
Will rotate the image by exif data.

Parameters:

uri - the URI to load the image from

setImageUriAsync

public void setImageUriAsync(android.net.Uri uri)

Sets a bitmap loaded from the given Android URI as the content of the CropImageView.
Can be used with URI from gallery or camera source.
Will rotate the image by exif data.

Parameters:

uri - the URI to load the image from

clearImage

public void clearImage()

Clear the current image set for cropping.

rotateImage

public void rotateImage(int degrees)

Rotates image by the specified number of degrees clockwise. Cycles from 0 to 360 degrees.

Parameters:

degrees - Integer specifying the number of degrees to rotate.

onSaveInstanceState

public android.os.Parcelable onSaveInstanceState()

Overrides:

onSaveInstanceState in class android.view.View

onRestoreInstanceState

public void onRestoreInstanceState(android.os.Parcelable state)

Overrides:

onRestoreInstanceState in class android.view.View

onSizeChanged

protected void onSizeChanged(int w,
                             int h,
                             int oldw,
                             int oldh)

Overrides:

onSizeChanged in class android.view.View

onMeasure

protected void onMeasure(int widthMeasureSpec,
                         int heightMeasureSpec)

Overrides:

onMeasure in class android.widget.FrameLayout

onLayout

protected void onLayout(boolean changed,
                        int l,
                        int t,
                        int r,
                        int b)

Overrides:

onLayout in class android.widget.FrameLayout