CropImageOptions (cropper API)

java.lang.Object
- com.theartofdev.edmodo.cropper.CropImageOptions

All Implemented Interfaces:

android.os.Parcelable
```
public class CropImageOptions
extends java.lang.Object
implements android.os.Parcelable
```
All the possible options that can be set to customize crop image.
Initialized with default values.

Nested Class Summary
- Nested classes/interfaces inherited from interface android.os.Parcelable
  android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`activityMenuIconColor` the color to use for action bar items icons
`java.lang.CharSequence`	`activityTitle` the title of the `CropImageActivity`
`boolean`	`allowCounterRotation` if to allow counter-clockwise rotation during cropping (activity)
`boolean`	`allowFlipping` if to allow (all) flipping during cropping (activity)
`boolean`	`allowRotation` if to allow (all) rotation during cropping (activity)
`int`	`aspectRatioX` the X value of the aspect ratio.
`int`	`aspectRatioY` the Y value of the aspect ratio.
`boolean`	`autoZoomEnabled` if auto-zoom functionality is enabled. default: true.
`int`	`backgroundColor` the color of the overlay background around the crop window cover the image parts not in the crop window.
`int`	`borderCornerColor` the color of the corner line
`float`	`borderCornerLength` the length of the corner line away from the corner.
`float`	`borderCornerOffset` the offset of corner line from crop window border.
`float`	`borderCornerThickness` thickness of the corner line.
`int`	`borderLineColor` the color of the guidelines lines
`float`	`borderLineThickness` the thickness of the guidelines lines in pixels.
`static android.os.Parcelable.Creator<CropImageOptions>`	`CREATOR`
`int`	`cropMenuCropButtonIcon` optional image resource to be used for crop menu crop icon instead of text
`java.lang.CharSequence`	`cropMenuCropButtonTitle` optional, the text of the crop menu crop button
`CropImageView.CropShape`	`cropShape` The shape of the cropping window.
`boolean`	`fixAspectRatio` whether the width to height aspect ratio should be maintained or free to change.
`boolean`	`flipHorizontally` whether the image should be flipped horizontally
`boolean`	`flipVertically` whether the image should be flipped vertically
`CropImageView.Guidelines`	`guidelines` whether the guidelines should be on, off, or only showing when resizing.
`int`	`guidelinesColor` the color of the guidelines lines
`float`	`guidelinesThickness` the thickness of the guidelines lines.
`float`	`initialCropWindowPaddingRatio` The initial crop window padding from image borders in percentage of the cropping image dimensions.
`android.graphics.Rect`	`initialCropWindowRectangle` the initial rectangle to set on the cropping image after loading
`int`	`initialRotation` the initial rotation to set on the cropping image after loading (0-360 degrees clockwise)
`int`	`maxCropResultHeight` the max height the resulting cropping image is allowed to be, affects the cropping window limits.
`int`	`maxCropResultWidth` the max width the resulting cropping image is allowed to be, affects the cropping window limits.
`int`	`maxZoom` The max zoom allowed during cropping.
`int`	`minCropResultHeight` the min height the resulting cropping image is allowed to be, affects the cropping window limits.
`int`	`minCropResultWidth` the min width the resulting cropping image is allowed to be, affects the cropping window limits.
`int`	`minCropWindowHeight` the min height the crop window is allowed to be.
`int`	`minCropWindowWidth` the min width the crop window is allowed to be.
`boolean`	`multiTouchEnabled` if multi-touch should be enabled on the crop box default: false
`boolean`	`noOutputImage` if the result of crop image activity should not save the cropped image bitmap
`android.graphics.Bitmap.CompressFormat`	`outputCompressFormat` the compression format to use when writing the image
`int`	`outputCompressQuality` the quality (if applicable) to use when writing the image (0 - 100)
`int`	`outputRequestHeight` the height to resize the cropped image to (see options)
`CropImageView.RequestSizeOptions`	`outputRequestSizeOptions` the resize method to use on the cropped bitmap (see options documentation)
`int`	`outputRequestWidth` the width to resize the cropped image to (see options)
`android.net.Uri`	`outputUri` the Android Uri to save the cropped image to
`int`	`rotationDegrees` the amount of degrees to rotate clockwise or counter-clockwise
`CropImageView.ScaleType`	`scaleType` The initial scale type of the image in the crop image view
`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.
`boolean`	`showProgressBar` if to show progress bar when image async loading/cropping is in progress. default: true, disable to provide custom progress bar UI.
`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.
`float`	`touchRadius` The radius of the touchable area around the handle.

Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors
Modifier Constructor and Description

CropImageOptions()
Init options with defaults.

protected CropImageOptions(android.os.Parcel in)
Create object from parcel.

Constructors
Modifier	Constructor and Description
	`CropImageOptions()` Init options with defaults.
`protected`	`CropImageOptions(android.os.Parcel in)` Create object from parcel.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`describeContents()`
`void`	`validate()` Validate all the options are withing valid range.
`void`	`writeToParcel(android.os.Parcel dest, int flags)`

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

- Field Detail
  - CREATOR
```
public static final android.os.Parcelable.Creator<CropImageOptions> CREATOR
```
  - cropShape
```
public CropImageView.CropShape cropShape
```
    The shape of the cropping window.
  - snapRadius
```
public 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)
  - touchRadius
```
public 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
  - guidelines
```
public CropImageView.Guidelines guidelines
```
    whether the guidelines should be on, off, or only showing when resizing.
  - scaleType
```
public CropImageView.ScaleType scaleType
```
    The initial scale type of the image in the crop image view
  - showCropOverlay
```
public 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.
  - showProgressBar
```
public boolean showProgressBar
```
    if to show progress bar when image async loading/cropping is in progress.
    default: true, disable to provide custom progress bar UI.
  - autoZoomEnabled
```
public boolean autoZoomEnabled
```
    if auto-zoom functionality is enabled.
    default: true.
  - multiTouchEnabled
```
public boolean multiTouchEnabled
```
    if multi-touch should be enabled on the crop box default: false
  - maxZoom
```
public int maxZoom
```
    The max zoom allowed during cropping.
  - initialCropWindowPaddingRatio
```
public float initialCropWindowPaddingRatio
```
    The initial crop window padding from image borders in percentage of the cropping image dimensions.
  - fixAspectRatio
```
public boolean fixAspectRatio
```
    whether the width to height aspect ratio should be maintained or free to change.
  - aspectRatioX
```
public int aspectRatioX
```
    the X value of the aspect ratio.
  - aspectRatioY
```
public int aspectRatioY
```
    the Y value of the aspect ratio.
  - borderLineThickness
```
public float borderLineThickness
```
    the thickness of the guidelines lines in pixels. (in pixels)
  - borderLineColor
```
public int borderLineColor
```
    the color of the guidelines lines
  - borderCornerThickness
```
public float borderCornerThickness
```
    thickness of the corner line. (in pixels)
  - borderCornerOffset
```
public float borderCornerOffset
```
    the offset of corner line from crop window border. (in pixels)
  - borderCornerLength
```
public float borderCornerLength
```
    the length of the corner line away from the corner. (in pixels)
  - borderCornerColor
```
public int borderCornerColor
```
    the color of the corner line
  - guidelinesThickness
```
public float guidelinesThickness
```
    the thickness of the guidelines lines. (in pixels)
  - guidelinesColor
```
public int guidelinesColor
```
    the color of the guidelines lines
  - backgroundColor
```
public int backgroundColor
```
    the color of the overlay background around the crop window cover the image parts not in the crop window.
  - minCropWindowWidth
```
public int minCropWindowWidth
```
    the min width the crop window is allowed to be. (in pixels)
  - minCropWindowHeight
```
public int minCropWindowHeight
```
    the min height the crop window is allowed to be. (in pixels)
  - minCropResultWidth
```
public int minCropResultWidth
```
    the min width the resulting cropping image is allowed to be, affects the cropping window limits. (in pixels)
  - minCropResultHeight
```
public int minCropResultHeight
```
    the min height the resulting cropping image is allowed to be, affects the cropping window limits. (in pixels)
  - maxCropResultWidth
```
public int maxCropResultWidth
```
    the max width the resulting cropping image is allowed to be, affects the cropping window limits. (in pixels)
  - maxCropResultHeight
```
public int maxCropResultHeight
```
    the max height the resulting cropping image is allowed to be, affects the cropping window limits. (in pixels)
  - activityTitle
```
public java.lang.CharSequence activityTitle
```
    the title of the CropImageActivity
  - activityMenuIconColor
```
public int activityMenuIconColor
```
    the color to use for action bar items icons
  - outputUri
```
public android.net.Uri outputUri
```
    the Android Uri to save the cropped image to
  - outputCompressFormat
```
public android.graphics.Bitmap.CompressFormat outputCompressFormat
```
    the compression format to use when writing the image
  - outputCompressQuality
```
public int outputCompressQuality
```
    the quality (if applicable) to use when writing the image (0 - 100)
  - outputRequestWidth
```
public int outputRequestWidth
```
    the width to resize the cropped image to (see options)
  - outputRequestHeight
```
public int outputRequestHeight
```
    the height to resize the cropped image to (see options)
  - outputRequestSizeOptions
```
public CropImageView.RequestSizeOptions outputRequestSizeOptions
```
    the resize method to use on the cropped bitmap (see options documentation)
  - noOutputImage
```
public boolean noOutputImage
```
    if the result of crop image activity should not save the cropped image bitmap
  - initialCropWindowRectangle
```
public android.graphics.Rect initialCropWindowRectangle
```
    the initial rectangle to set on the cropping image after loading
  - initialRotation
```
public int initialRotation
```
    the initial rotation to set on the cropping image after loading (0-360 degrees clockwise)
  - allowRotation
```
public boolean allowRotation
```
    if to allow (all) rotation during cropping (activity)
  - allowFlipping
```
public boolean allowFlipping
```
    if to allow (all) flipping during cropping (activity)
  - allowCounterRotation
```
public boolean allowCounterRotation
```
    if to allow counter-clockwise rotation during cropping (activity)
  - rotationDegrees
```
public int rotationDegrees
```
    the amount of degrees to rotate clockwise or counter-clockwise
  - flipHorizontally
```
public boolean flipHorizontally
```
    whether the image should be flipped horizontally
  - flipVertically
```
public boolean flipVertically
```
    whether the image should be flipped vertically
  - cropMenuCropButtonTitle
```
public java.lang.CharSequence cropMenuCropButtonTitle
```
    optional, the text of the crop menu crop button
  - cropMenuCropButtonIcon
```
public int cropMenuCropButtonIcon
```
    optional image resource to be used for crop menu crop icon instead of text
- Constructor Detail
  - CropImageOptions
```
public CropImageOptions()
```
    Init options with defaults.
  - CropImageOptions
```
protected CropImageOptions(android.os.Parcel in)
```
    Create object from parcel.
- Method Detail
  - writeToParcel
```
public void writeToParcel(android.os.Parcel dest,
                          int flags)
```
    Specified by:
    
    writeToParcel in interface android.os.Parcelable
  - describeContents
```
public int describeContents()
```
    Specified by:
    
    describeContents in interface android.os.Parcelable
  - validate
```
public void validate()
```
    Validate all the options are withing valid range.
    
    Throws:
    
    java.lang.IllegalArgumentException - if any of the options is not valid

Class CropImageOptions

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Field Summary

Fields inherited from interface android.os.Parcelable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CREATOR

cropShape

snapRadius

touchRadius

guidelines

scaleType

showCropOverlay

showProgressBar

autoZoomEnabled

multiTouchEnabled

maxZoom

initialCropWindowPaddingRatio

fixAspectRatio

aspectRatioX

aspectRatioY

borderLineThickness

borderLineColor

borderCornerThickness

borderCornerOffset

borderCornerLength

borderCornerColor

guidelinesThickness

guidelinesColor

backgroundColor

minCropWindowWidth

minCropWindowHeight

minCropResultWidth

minCropResultHeight

maxCropResultWidth

maxCropResultHeight

activityTitle

activityMenuIconColor

outputUri

outputCompressFormat

outputCompressQuality

outputRequestWidth

outputRequestHeight

outputRequestSizeOptions

noOutputImage

initialCropWindowRectangle

initialRotation

allowRotation

allowFlipping

allowCounterRotation

rotationDegrees

flipHorizontally

flipVertically

cropMenuCropButtonTitle

cropMenuCropButtonIcon

Constructor Detail

CropImageOptions

CropImageOptions

Method Detail

writeToParcel

describeContents

validate