com.yalantis.ucrop.view

Class OverlayView

java.lang.Object

android.view.View

com.yalantis.ucrop.view.OverlayView

All Implemented Interfaces:

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

public class OverlayView
extends android.view.View

Created by Oleksii Shliama (https://github.com/shliama).

This view is used for drawing the overlay on top of the image. It may have frame, crop guidelines and dimmed area. This must have LAYER_TYPE_SOFTWARE to draw itself properly.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OverlayView.FreestyleMode

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

Modifier and Type	Field and Description
static boolean	DEFAULT_CIRCLE_DIMMED_LAYER
static int	DEFAULT_CROP_GRID_COLUMN_COUNT
static int	DEFAULT_CROP_GRID_ROW_COUNT
static int	DEFAULT_FREESTYLE_CROP_MODE
static boolean	DEFAULT_SHOW_CROP_FRAME
static boolean	DEFAULT_SHOW_CROP_GRID
static int	FREESTYLE_CROP_MODE_DISABLE
static int	FREESTYLE_CROP_MODE_ENABLE
static int	FREESTYLE_CROP_MODE_ENABLE_WITH_PASS_THROUGH
protected float[]	mCropGridCenter
protected float[]	mCropGridCorners
protected int	mThisHeight
protected int	mThisWidth

Fields inherited from class android.view.View

ACCESSIBILITY_LIVE_REGION_ASSERTIVE, ACCESSIBILITY_LIVE_REGION_NONE, ACCESSIBILITY_LIVE_REGION_POLITE, ALPHA, 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, 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
OverlayView(android.content.Context context)
OverlayView(android.content.Context context, android.util.AttributeSet attrs)
OverlayView(android.content.Context context, android.util.AttributeSet attrs, int defStyle)

Method Summary

Modifier and Type	Method and Description
protected void	drawCropGrid(android.graphics.Canvas canvas) This method draws crop bounds (empty rectangle) and crop guidelines (vertical and horizontal lines inside the crop bounds) if needed.
protected void	drawDimmedLayer(android.graphics.Canvas canvas) This method draws dimmed area around the crop bounds.
android.graphics.RectF	getCropViewRect()
int	getFreestyleCropMode()
OverlayViewChangeListener	getOverlayViewChangeListener()
protected void	init()
boolean	isFreestyleCropEnabled() Deprecated.
protected void	onDraw(android.graphics.Canvas canvas) Along with image there are dimmed layer, crop bounds and crop guidelines that must be drawn.
protected void	onLayout(boolean changed, int left, int top, int right, int bottom)
boolean	onTouchEvent(android.view.MotionEvent event)
protected void	processStyledAttributes(android.content.res.TypedArray a) This method extracts all needed values from the styled attributes.
void	setCircleDimmedLayer(boolean circleDimmedLayer) Setter for mCircleDimmedLayer variable.
void	setCropFrameColor(int color) Setter for crop frame color
void	setCropFrameStrokeWidth(int width) Setter for crop frame stroke width
void	setCropGridColor(int color) Setter for crop grid color
void	setCropGridColumnCount(int cropGridColumnCount) Setter for crop grid columns count.
void	setCropGridRowCount(int cropGridRowCount) Setter for crop grid rows count.
void	setCropGridStrokeWidth(int width) Setter for crop grid stroke width
void	setDimmedColor(int dimmedColor) Setter for mDimmedColor variable.
void	setFreestyleCropEnabled(boolean freestyleCropEnabled) Deprecated.
void	setFreestyleCropMode(int mFreestyleCropMode)
void	setOverlayViewChangeListener(OverlayViewChangeListener callback)
void	setShowCropFrame(boolean showCropFrame) Setter for mShowCropFrame variable.
void	setShowCropGrid(boolean showCropGrid) Setter for mShowCropGrid variable.
void	setTargetAspectRatio(float targetAspectRatio) This method sets aspect ratio for crop bounds.
void	setupCropBounds() This method setups crop bounds rectangles for given aspect ratio and view size.

Methods inherited from class android.view.View

addChildrenForAccessibility, addFocusables, addFocusables, addOnAttachStateChangeListener, addOnLayoutChangeListener, addTouchables, animate, announceForAccessibility, 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, dispatchConfigurationChanged, dispatchDisplayHint, dispatchDragEvent, dispatchDraw, dispatchDrawableHotspotChanged, dispatchFinishTemporaryDetach, dispatchGenericFocusedEvent, dispatchGenericMotionEvent, dispatchGenericPointerEvent, dispatchHoverEvent, dispatchKeyEvent, dispatchKeyEventPreIme, dispatchKeyShortcutEvent, dispatchNestedFling, dispatchNestedPreFling, dispatchNestedPrePerformAccessibilityAction, dispatchNestedPreScroll, dispatchNestedScroll, dispatchPopulateAccessibilityEvent, 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, 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, getHasOverlappingRendering, 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, 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, getTop, getTopFadingEdgeStrength, getTopPaddingOffset, getTouchables, getTouchDelegate, getTransitionName, getTranslationX, getTranslationY, getTranslationZ, getVerticalFadingEdgeLength, getVerticalScrollbarPosition, getVerticalScrollbarWidth, getViewTreeObserver, getVisibility, getWidth, getWindowAttachCount, getWindowId, getWindowSystemUiVisibility, getWindowToken, getWindowVisibility, getWindowVisibleDisplayFrame, getX, getY, getZ, hasFocus, hasFocusable, hasNestedScrollingParent, hasOnClickListeners, hasOverlappingRendering, hasTransientState, 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, isTemporarilyDetached, isTextAlignmentResolved, isTextDirectionResolved, isVerticalFadingEdgeEnabled, isVerticalScrollBarEnabled, jumpDrawablesToCurrentState, layout, measure, mergeDrawableStates, offsetLeftAndRight, offsetTopAndBottom, onAnimationEnd, onAnimationStart, onApplyWindowInsets, onAttachedToWindow, onCancelPendingInputEvents, 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, onMeasure, onOverScrolled, onPopulateAccessibilityEvent, onProvideStructure, onProvideVirtualStructure, onResolvePointerIcon, onRestoreInstanceState, onRtlPropertiesChanged, onSaveInstanceState, onScreenStateChanged, onScrollChanged, onSetAlpha, onSizeChanged, 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, removeCallbacks, removeOnAttachStateChangeListener, removeOnLayoutChangeListener, requestApplyInsets, requestFitSystemWindows, requestFocus, 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, setForegroundGravity, 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, 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, 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, willNotDraw

Methods inherited from class java.lang.Object

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

Field Detail

FREESTYLE_CROP_MODE_DISABLE

public static final int FREESTYLE_CROP_MODE_DISABLE

See Also:

Constant Field Values

FREESTYLE_CROP_MODE_ENABLE

public static final int FREESTYLE_CROP_MODE_ENABLE

See Also:

Constant Field Values

FREESTYLE_CROP_MODE_ENABLE_WITH_PASS_THROUGH

public static final int FREESTYLE_CROP_MODE_ENABLE_WITH_PASS_THROUGH

See Also:

Constant Field Values

DEFAULT_SHOW_CROP_FRAME

public static final boolean DEFAULT_SHOW_CROP_FRAME

See Also:

Constant Field Values

DEFAULT_SHOW_CROP_GRID

public static final boolean DEFAULT_SHOW_CROP_GRID

See Also:

Constant Field Values

DEFAULT_CIRCLE_DIMMED_LAYER

public static final boolean DEFAULT_CIRCLE_DIMMED_LAYER

See Also:

Constant Field Values

DEFAULT_FREESTYLE_CROP_MODE

public static final int DEFAULT_FREESTYLE_CROP_MODE

See Also:

Constant Field Values

DEFAULT_CROP_GRID_ROW_COUNT

public static final int DEFAULT_CROP_GRID_ROW_COUNT

See Also:

Constant Field Values

DEFAULT_CROP_GRID_COLUMN_COUNT

public static final int DEFAULT_CROP_GRID_COLUMN_COUNT

See Also:

Constant Field Values

mThisWidth

protected int mThisWidth

mThisHeight

protected int mThisHeight

mCropGridCorners

protected float[] mCropGridCorners

mCropGridCenter

protected float[] mCropGridCenter

Constructor Detail

OverlayView

public OverlayView(android.content.Context context)

OverlayView

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

OverlayView

public OverlayView(android.content.Context context,
                   android.util.AttributeSet attrs,
                   int defStyle)

Method Detail

getOverlayViewChangeListener

public OverlayViewChangeListener getOverlayViewChangeListener()

setOverlayViewChangeListener

public void setOverlayViewChangeListener(OverlayViewChangeListener callback)

getCropViewRect

public android.graphics.RectF getCropViewRect()

isFreestyleCropEnabled

@Deprecated
public boolean isFreestyleCropEnabled()

Deprecated.

setFreestyleCropEnabled

@Deprecated
public void setFreestyleCropEnabled(boolean freestyleCropEnabled)

Deprecated.

getFreestyleCropMode

public int getFreestyleCropMode()

setFreestyleCropMode

public void setFreestyleCropMode(int mFreestyleCropMode)

setCircleDimmedLayer

public void setCircleDimmedLayer(boolean circleDimmedLayer)

Setter for mCircleDimmedLayer variable.

Parameters:

circleDimmedLayer - - set it to true if you want dimmed layer to be an circle

setCropGridRowCount

public void setCropGridRowCount(int cropGridRowCount)

Setter for crop grid rows count. Resets mGridPoints variable because it is not valid anymore.

setCropGridColumnCount

public void setCropGridColumnCount(int cropGridColumnCount)

Setter for crop grid columns count. Resets mGridPoints variable because it is not valid anymore.

setShowCropFrame

public void setShowCropFrame(boolean showCropFrame)

Setter for mShowCropFrame variable.

Parameters:

showCropFrame - - set to true if you want to see a crop frame rectangle on top of an image

setShowCropGrid

public void setShowCropGrid(boolean showCropGrid)

Setter for mShowCropGrid variable.

Parameters:

showCropGrid - - set to true if you want to see a crop grid on top of an image

setDimmedColor

public void setDimmedColor(int dimmedColor)

Setter for mDimmedColor variable.

Parameters:

dimmedColor - - desired color of dimmed area around the crop bounds

setCropFrameStrokeWidth

public void setCropFrameStrokeWidth(int width)

Setter for crop frame stroke width

setCropGridStrokeWidth

public void setCropGridStrokeWidth(int width)

Setter for crop grid stroke width

setCropFrameColor

public void setCropFrameColor(int color)

Setter for crop frame color

setCropGridColor

public void setCropGridColor(int color)

Setter for crop grid color

setTargetAspectRatio

public void setTargetAspectRatio(float targetAspectRatio)

This method sets aspect ratio for crop bounds.

Parameters:

targetAspectRatio - - aspect ratio for image crop (e.g. 1.77(7) for 16:9)

setupCropBounds

public void setupCropBounds()

This method setups crop bounds rectangles for given aspect ratio and view size. mCropViewRect is used to draw crop bounds - uses padding.

init

protected void init()

onLayout

protected void onLayout(boolean changed,
                        int left,
                        int top,
                        int right,
                        int bottom)

Overrides:

onLayout in class android.view.View

onDraw

protected void onDraw(android.graphics.Canvas canvas)

Along with image there are dimmed layer, crop bounds and crop guidelines that must be drawn.

Overrides:

onDraw in class android.view.View

onTouchEvent

public boolean onTouchEvent(android.view.MotionEvent event)

Overrides:

onTouchEvent in class android.view.View

drawDimmedLayer

protected void drawDimmedLayer(android.graphics.Canvas canvas)

This method draws dimmed area around the crop bounds.

Parameters:

canvas - - valid canvas object

drawCropGrid

protected void drawCropGrid(android.graphics.Canvas canvas)

This method draws crop bounds (empty rectangle) and crop guidelines (vertical and horizontal lines inside the crop bounds) if needed.

Parameters:

canvas - - valid canvas object

processStyledAttributes

protected void processStyledAttributes(android.content.res.TypedArray a)

This method extracts all needed values from the styled attributes. Those are used to configure the view.