CropImage.ActivityBuilder (cropper API)

java.lang.Object
- com.theartofdev.edmodo.cropper.CropImage.ActivityBuilder

Enclosing class:

CropImage
```
public static final class CropImage.ActivityBuilder
extends java.lang.Object
```
Builder used for creating Image Crop Activity by user request.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`android.content.Intent`	`getIntent(android.content.Context context)` Get `CropImageActivity` intent to start the activity.
`android.content.Intent`	`getIntent(android.content.Context context, java.lang.Class<?> cls)` Get `CropImageActivity` intent to start the activity.
`CropImage.ActivityBuilder`	`setActivityMenuIconColor(int activityMenuIconColor)` the color to use for action bar items icons. Default: NONE
`CropImage.ActivityBuilder`	`setActivityTitle(java.lang.CharSequence activityTitle)` the title of the `CropImageActivity`. Default: ""
`CropImage.ActivityBuilder`	`setAllowCounterRotation(boolean allowCounterRotation)` if to allow counter-clockwise rotation during cropping. Note: if rotation is disabled this option has no effect. Default: false
`CropImage.ActivityBuilder`	`setAllowFlipping(boolean allowFlipping)` if to allow flipping during cropping. Default: true
`CropImage.ActivityBuilder`	`setAllowRotation(boolean allowRotation)` if to allow rotation during cropping. Default: true
`CropImage.ActivityBuilder`	`setAspectRatio(int aspectRatioX, int aspectRatioY)` the X,Y value of the aspect ratio. Also sets fixes aspect ratio to TRUE. Default: 1/1
`CropImage.ActivityBuilder`	`setAutoZoomEnabled(boolean autoZoomEnabled)` if auto-zoom functionality is enabled. default: true.
`CropImage.ActivityBuilder`	`setBackgroundColor(int backgroundColor)` the color of the overlay background around the crop window cover the image parts not in the crop window. Default: Color.argb(119, 0, 0, 0)
`CropImage.ActivityBuilder`	`setBorderCornerColor(int borderCornerColor)` the color of the corner line. Default: WHITE
`CropImage.ActivityBuilder`	`setBorderCornerLength(float borderCornerLength)` the length of the corner line away from the corner (in pixels). Default: 14dp
`CropImage.ActivityBuilder`	`setBorderCornerOffset(float borderCornerOffset)` the offset of corner line from crop window border (in pixels). Default: 5dp
`CropImage.ActivityBuilder`	`setBorderCornerThickness(float borderCornerThickness)` thickness of the corner line (in pixels). Default: 2dp
`CropImage.ActivityBuilder`	`setBorderLineColor(int borderLineColor)` the color of the guidelines lines. Default: Color.argb(170, 255, 255, 255)
`CropImage.ActivityBuilder`	`setBorderLineThickness(float borderLineThickness)` the thickness of the guidelines lines (in pixels). Default: 3dp
`CropImage.ActivityBuilder`	`setCropMenuCropButtonIcon(int drawableResource)` Image resource id to use for crop icon instead of text. Default: 0
`CropImage.ActivityBuilder`	`setCropMenuCropButtonTitle(java.lang.CharSequence title)` optional, set crop menu crop button title. Default: null, will use resource string: crop_image_menu_crop
`CropImage.ActivityBuilder`	`setCropShape(CropImageView.CropShape cropShape)` The shape of the cropping window. To set square/circle crop shape set aspect ratio to 1:1. Default: RECTANGLE
`CropImage.ActivityBuilder`	`setFixAspectRatio(boolean fixAspectRatio)` whether the width to height aspect ratio should be maintained or free to change. Default: false
`CropImage.ActivityBuilder`	`setFlipHorizontally(boolean flipHorizontally)` whether the image should be flipped horizontally. Default: false
`CropImage.ActivityBuilder`	`setFlipVertically(boolean flipVertically)` whether the image should be flipped vertically. Default: false
`CropImage.ActivityBuilder`	`setGuidelines(CropImageView.Guidelines guidelines)` whether the guidelines should be on, off, or only showing when resizing. Default: ON_TOUCH
`CropImage.ActivityBuilder`	`setGuidelinesColor(int guidelinesColor)` the color of the guidelines lines. Default: Color.argb(170, 255, 255, 255)
`CropImage.ActivityBuilder`	`setGuidelinesThickness(float guidelinesThickness)` the thickness of the guidelines lines (in pixels). Default: 1dp
`CropImage.ActivityBuilder`	`setInitialCropWindowPaddingRatio(float initialCropWindowPaddingRatio)` The initial crop window padding from image borders in percentage of the cropping image dimensions. Default: 0.1
`CropImage.ActivityBuilder`	`setInitialCropWindowRectangle(android.graphics.Rect initialCropWindowRectangle)` the initial rectangle to set on the cropping image after loading. Default: NONE - will initialize using initial crop window padding ratio
`CropImage.ActivityBuilder`	`setInitialRotation(int initialRotation)` the initial rotation to set on the cropping image after loading (0-360 degrees clockwise).
`CropImage.ActivityBuilder`	`setMaxCropResultSize(int maxCropResultWidth, int maxCropResultHeight)` the max size the resulting cropping image is allowed to be, affects the cropping window limits (in pixels). Default: 99999, 99999
`CropImage.ActivityBuilder`	`setMaxZoom(int maxZoom)` The max zoom allowed during cropping. Default: 4
`CropImage.ActivityBuilder`	`setMinCropResultSize(int minCropResultWidth, int minCropResultHeight)` the min size the resulting cropping image is allowed to be, affects the cropping window limits (in pixels). Default: 40px, 40px
`CropImage.ActivityBuilder`	`setMinCropWindowSize(int minCropWindowWidth, int minCropWindowHeight)` the min size the crop window is allowed to be (in pixels). Default: 42dp, 42dp
`CropImage.ActivityBuilder`	`setMultiTouchEnabled(boolean multiTouchEnabled)` if multi touch functionality is enabled. default: true.
`CropImage.ActivityBuilder`	`setNoOutputImage(boolean noOutputImage)` if the result of crop image activity should not save the cropped image bitmap. Used if you want to crop the image manually and need only the crop rectangle and rotation data. Default: false
`CropImage.ActivityBuilder`	`setOutputCompressFormat(android.graphics.Bitmap.CompressFormat outputCompressFormat)` the compression format to use when writting the image. Default: JPEG
`CropImage.ActivityBuilder`	`setOutputCompressQuality(int outputCompressQuality)` the quility (if applicable) to use when writting the image (0 - 100). Default: 90
`CropImage.ActivityBuilder`	`setOutputUri(android.net.Uri outputUri)` the Android Uri to save the cropped image to. Default: NONE, will create a temp file
`CropImage.ActivityBuilder`	`setRequestedSize(int reqWidth, int reqHeight)` the size to resize the cropped image to. Uses `CropImageView.RequestSizeOptions.RESIZE_INSIDE` option. Default: 0, 0 - not set, will not resize
`CropImage.ActivityBuilder`	`setRequestedSize(int reqWidth, int reqHeight, CropImageView.RequestSizeOptions options)` the size to resize the cropped image to. Default: 0, 0 - not set, will not resize
`CropImage.ActivityBuilder`	`setRotationDegrees(int rotationDegrees)` The amount of degreees to rotate clockwise or counter-clockwise (0-360). Default: 90
`CropImage.ActivityBuilder`	`setScaleType(CropImageView.ScaleType scaleType)` The initial scale type of the image in the crop image view Default: FIT_CENTER
`CropImage.ActivityBuilder`	`setShowCropOverlay(boolean showCropOverlay)` if to show crop overlay UI what contains the crop window UI surrounded by background over the cropping image. default: true, may disable for animation or frame transition.
`CropImage.ActivityBuilder`	`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 (in pixels). Default: 3dp
`CropImage.ActivityBuilder`	`setTouchRadius(float touchRadius)` The radius of the touchable area around the handle (in pixels). We are basing this value off of the recommended 48dp Rhythm. See: http://developer.android.com/design/style/metrics-grids.html#48dp-rhythm Default: 48dp
`void`	`start(android.app.Activity activity)` Start `CropImageActivity`.
`void`	`start(android.app.Activity activity, java.lang.Class<?> cls)` Start `CropImageActivity`.
`void`	`start(android.content.Context context, Fragment fragment)` Start `CropImageActivity`.
`void`	`start(android.content.Context context, Fragment fragment, java.lang.Class<?> cls)` Start `CropImageActivity`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getIntent
```
public android.content.Intent getIntent(android.content.Context context)
```
    Get CropImageActivity intent to start the activity.
  - getIntent
```
public android.content.Intent getIntent(android.content.Context context,
                                        java.lang.Class<?> cls)
```
    Get CropImageActivity intent to start the activity.
  - start
```
public void start(android.app.Activity activity)
```
    Start CropImageActivity.
    
    Parameters:
    
    activity - activity to receive result
  - start
```
public void start(android.app.Activity activity,
                  java.lang.Class<?> cls)
```
    Start CropImageActivity.
    
    Parameters:
    
    activity - activity to receive result
  - start
```
public void start(android.content.Context context,
                  Fragment fragment)
```
    Start CropImageActivity.
    
    Parameters:
    
    fragment - fragment to receive result
  - start
```
public void start(android.content.Context context,
                  Fragment fragment,
                  java.lang.Class<?> cls)
```
    Start CropImageActivity.
    
    Parameters:
    
    fragment - fragment to receive result
  - setCropShape
```
public CropImage.ActivityBuilder setCropShape(CropImageView.CropShape cropShape)
```
    The shape of the cropping window.
    To set square/circle crop shape set aspect ratio to 1:1.
    Default: RECTANGLE
  - setSnapRadius
```
public CropImage.ActivityBuilder 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 (in pixels).
    Default: 3dp
  - setTouchRadius
```
public CropImage.ActivityBuilder setTouchRadius(float touchRadius)
```
    The radius of the touchable area around the handle (in pixels).
    We are basing this value off of the recommended 48dp Rhythm.
    See: http://developer.android.com/design/style/metrics-grids.html#48dp-rhythm
    Default: 48dp
  - setGuidelines
```
public CropImage.ActivityBuilder setGuidelines(CropImageView.Guidelines guidelines)
```
    whether the guidelines should be on, off, or only showing when resizing.
    Default: ON_TOUCH
  - setScaleType
```
public CropImage.ActivityBuilder setScaleType(CropImageView.ScaleType scaleType)
```
    The initial scale type of the image in the crop image view
    Default: FIT_CENTER
  - setShowCropOverlay
```
public CropImage.ActivityBuilder setShowCropOverlay(boolean showCropOverlay)
```
    if to show crop overlay UI what contains the crop window UI surrounded by background over the cropping image.
    default: true, may disable for animation or frame transition.
  - setAutoZoomEnabled
```
public CropImage.ActivityBuilder setAutoZoomEnabled(boolean autoZoomEnabled)
```
    if auto-zoom functionality is enabled.
    default: true.
  - setMultiTouchEnabled
```
public CropImage.ActivityBuilder setMultiTouchEnabled(boolean multiTouchEnabled)
```
    if multi touch functionality is enabled.
    default: true.
  - setMaxZoom
```
public CropImage.ActivityBuilder setMaxZoom(int maxZoom)
```
    The max zoom allowed during cropping.
    Default: 4
  - setInitialCropWindowPaddingRatio
```
public CropImage.ActivityBuilder setInitialCropWindowPaddingRatio(float initialCropWindowPaddingRatio)
```
    The initial crop window padding from image borders in percentage of the cropping image dimensions.
    Default: 0.1
  - setFixAspectRatio
```
public CropImage.ActivityBuilder setFixAspectRatio(boolean fixAspectRatio)
```
    whether the width to height aspect ratio should be maintained or free to change.
    Default: false
  - setAspectRatio
```
public CropImage.ActivityBuilder setAspectRatio(int aspectRatioX,
                                                int aspectRatioY)
```
    the X,Y value of the aspect ratio.
    Also sets fixes aspect ratio to TRUE.
    Default: 1/1
    
    Parameters:
    
    aspectRatioX - the width
    
    aspectRatioY - the height
  - setBorderLineThickness
```
public CropImage.ActivityBuilder setBorderLineThickness(float borderLineThickness)
```
    the thickness of the guidelines lines (in pixels).
    Default: 3dp
  - setBorderLineColor
```
public CropImage.ActivityBuilder setBorderLineColor(int borderLineColor)
```
    the color of the guidelines lines.
    Default: Color.argb(170, 255, 255, 255)
  - setBorderCornerThickness
```
public CropImage.ActivityBuilder setBorderCornerThickness(float borderCornerThickness)
```
    thickness of the corner line (in pixels).
    Default: 2dp
  - setBorderCornerOffset
```
public CropImage.ActivityBuilder setBorderCornerOffset(float borderCornerOffset)
```
    the offset of corner line from crop window border (in pixels).
    Default: 5dp
  - setBorderCornerLength
```
public CropImage.ActivityBuilder setBorderCornerLength(float borderCornerLength)
```
    the length of the corner line away from the corner (in pixels).
    Default: 14dp
  - setBorderCornerColor
```
public CropImage.ActivityBuilder setBorderCornerColor(int borderCornerColor)
```
    the color of the corner line.
    Default: WHITE
  - setGuidelinesThickness
```
public CropImage.ActivityBuilder setGuidelinesThickness(float guidelinesThickness)
```
    the thickness of the guidelines lines (in pixels).
    Default: 1dp
  - setGuidelinesColor
```
public CropImage.ActivityBuilder setGuidelinesColor(int guidelinesColor)
```
    the color of the guidelines lines.
    Default: Color.argb(170, 255, 255, 255)
  - setBackgroundColor
```
public CropImage.ActivityBuilder setBackgroundColor(int backgroundColor)
```
    the color of the overlay background around the crop window cover the image parts not in the crop window.
    Default: Color.argb(119, 0, 0, 0)
  - setMinCropWindowSize
```
public CropImage.ActivityBuilder setMinCropWindowSize(int minCropWindowWidth,
                                                      int minCropWindowHeight)
```
    the min size the crop window is allowed to be (in pixels).
    Default: 42dp, 42dp
  - setMinCropResultSize
```
public CropImage.ActivityBuilder setMinCropResultSize(int minCropResultWidth,
                                                      int minCropResultHeight)
```
    the min size the resulting cropping image is allowed to be, affects the cropping window limits (in pixels).
    Default: 40px, 40px
  - setMaxCropResultSize
```
public CropImage.ActivityBuilder setMaxCropResultSize(int maxCropResultWidth,
                                                      int maxCropResultHeight)
```
    the max size the resulting cropping image is allowed to be, affects the cropping window limits (in pixels).
    Default: 99999, 99999
  - setActivityTitle
```
public CropImage.ActivityBuilder setActivityTitle(java.lang.CharSequence activityTitle)
```
    the title of the CropImageActivity.
    Default: ""
  - setActivityMenuIconColor
```
public CropImage.ActivityBuilder setActivityMenuIconColor(int activityMenuIconColor)
```
    the color to use for action bar items icons.
    Default: NONE
  - setOutputUri
```
public CropImage.ActivityBuilder setOutputUri(android.net.Uri outputUri)
```
    the Android Uri to save the cropped image to.
    Default: NONE, will create a temp file
  - setOutputCompressFormat
```
public CropImage.ActivityBuilder setOutputCompressFormat(android.graphics.Bitmap.CompressFormat outputCompressFormat)
```
    the compression format to use when writting the image.
    Default: JPEG
  - setOutputCompressQuality
```
public CropImage.ActivityBuilder setOutputCompressQuality(int outputCompressQuality)
```
    the quility (if applicable) to use when writting the image (0 - 100).
    Default: 90
  - setRequestedSize
```
public CropImage.ActivityBuilder setRequestedSize(int reqWidth,
                                                  int reqHeight)
```
    the size to resize the cropped image to.
    Uses CropImageView.RequestSizeOptions.RESIZE_INSIDE option.
    Default: 0, 0 - not set, will not resize
  - setRequestedSize
```
public CropImage.ActivityBuilder setRequestedSize(int reqWidth,
                                                  int reqHeight,
                                                  CropImageView.RequestSizeOptions options)
```
    the size to resize the cropped image to.
    Default: 0, 0 - not set, will not resize
  - setNoOutputImage
```
public CropImage.ActivityBuilder setNoOutputImage(boolean noOutputImage)
```
    if the result of crop image activity should not save the cropped image bitmap.
    Used if you want to crop the image manually and need only the crop rectangle and rotation data.
    Default: false
  - setInitialCropWindowRectangle
```
public CropImage.ActivityBuilder setInitialCropWindowRectangle(android.graphics.Rect initialCropWindowRectangle)
```
    the initial rectangle to set on the cropping image after loading.
    Default: NONE - will initialize using initial crop window padding ratio
  - setInitialRotation
```
public CropImage.ActivityBuilder setInitialRotation(int initialRotation)
```
    the initial rotation to set on the cropping image after loading (0-360 degrees clockwise).
    Default: NONE - will read image exif data
  - setAllowRotation
```
public CropImage.ActivityBuilder setAllowRotation(boolean allowRotation)
```
    if to allow rotation during cropping.
    Default: true
  - setAllowFlipping
```
public CropImage.ActivityBuilder setAllowFlipping(boolean allowFlipping)
```
    if to allow flipping during cropping.
    Default: true
  - setAllowCounterRotation
```
public CropImage.ActivityBuilder setAllowCounterRotation(boolean allowCounterRotation)
```
    if to allow counter-clockwise rotation during cropping.
    Note: if rotation is disabled this option has no effect.
    Default: false
  - setRotationDegrees
```
public CropImage.ActivityBuilder setRotationDegrees(int rotationDegrees)
```
    The amount of degreees to rotate clockwise or counter-clockwise (0-360).
    Default: 90
  - setFlipHorizontally
```
public CropImage.ActivityBuilder setFlipHorizontally(boolean flipHorizontally)
```
    whether the image should be flipped horizontally.
    Default: false
  - setFlipVertically
```
public CropImage.ActivityBuilder setFlipVertically(boolean flipVertically)
```
    whether the image should be flipped vertically.
    Default: false
  - setCropMenuCropButtonTitle
```
public CropImage.ActivityBuilder setCropMenuCropButtonTitle(java.lang.CharSequence title)
```
    optional, set crop menu crop button title.
    Default: null, will use resource string: crop_image_menu_crop
  - setCropMenuCropButtonIcon
```
public CropImage.ActivityBuilder setCropMenuCropButtonIcon(int drawableResource)
```
    Image resource id to use for crop icon instead of text.
    Default: 0

Class CropImage.ActivityBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getIntent

getIntent

start

start

start

start

setCropShape

setSnapRadius

setTouchRadius

setGuidelines

setScaleType

setShowCropOverlay

setAutoZoomEnabled

setMultiTouchEnabled

setMaxZoom

setInitialCropWindowPaddingRatio

setFixAspectRatio

setAspectRatio

setBorderLineThickness

setBorderLineColor

setBorderCornerThickness

setBorderCornerOffset

setBorderCornerLength

setBorderCornerColor

setGuidelinesThickness

setGuidelinesColor

setBackgroundColor

setMinCropWindowSize

setMinCropResultSize

setMaxCropResultSize

setActivityTitle

setActivityMenuIconColor

setOutputUri

setOutputCompressFormat

setOutputCompressQuality

setRequestedSize

setRequestedSize

setNoOutputImage

setInitialCropWindowRectangle

setInitialRotation

setAllowRotation

setAllowFlipping

setAllowCounterRotation

setRotationDegrees

setFlipHorizontally

setFlipVertically

setCropMenuCropButtonTitle

setCropMenuCropButtonIcon