UCrop (ucrop 1.0.0-chrome289 API)

java.lang.Object
- com.yalantis.ucrop.UCrop

```
public class UCrop
extends java.lang.Object
```
Created by Oleksii Shliama (https://github.com/shliama).
Builder class to ease Intent setup.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UCrop.Options
Class that helps to setup advanced configs that are not commonly used.

Nested Classes
Modifier and Type	Class and Description
`static class`	`UCrop.Options` Class that helps to setup advanced configs that are not commonly used.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`EXTRA_ASPECT_RATIO_X`
`static java.lang.String`	`EXTRA_ASPECT_RATIO_Y`
`static java.lang.String`	`EXTRA_ERROR`
`static java.lang.String`	`EXTRA_INPUT_URI`
`static java.lang.String`	`EXTRA_MAX_SIZE_X`
`static java.lang.String`	`EXTRA_MAX_SIZE_Y`
`static java.lang.String`	`EXTRA_OUTPUT_CROP_ASPECT_RATIO`
`static java.lang.String`	`EXTRA_OUTPUT_IMAGE_HEIGHT`
`static java.lang.String`	`EXTRA_OUTPUT_IMAGE_WIDTH`
`static java.lang.String`	`EXTRA_OUTPUT_OFFSET_X`
`static java.lang.String`	`EXTRA_OUTPUT_OFFSET_Y`
`static java.lang.String`	`EXTRA_OUTPUT_URI`
`static int`	`REQUEST_CROP`
`static int`	`RESULT_ERROR`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.Throwable`	`getError(android.content.Intent result)` Method retrieves error from the result intent.
`android.content.Intent`	`getIntent(android.content.Context context)` Get Intent to start `UCropActivity`
`static android.net.Uri`	`getOutput(android.content.Intent intent)` Retrieve cropped image Uri from the result Intent
`static float`	`getOutputCropAspectRatio(android.content.Intent intent)` Retrieve cropped image aspect ratio from the result Intent
`static int`	`getOutputImageHeight(android.content.Intent intent)` Retrieve the height of the cropped image
`static int`	`getOutputImageWidth(android.content.Intent intent)` Retrieve the width of the cropped image
`static UCrop`	`of(android.net.Uri source, android.net.Uri destination)` This method creates new Intent builder and sets both source and destination image URIs.
`void`	`start(android.app.Activity activity)` Send the crop Intent from an Activity
`void`	`start(android.app.Activity activity, int requestCode)` Send the crop Intent from an Activity with a custom request code
`void`	`start(android.content.Context context, android.support.v4.app.Fragment fragment)` Send the crop Intent from a support library Fragment
`void`	`start(android.content.Context context, android.support.v4.app.Fragment fragment, int requestCode)` Send the crop Intent with a custom request code
`void`	`start(android.content.Context context, android.app.Fragment fragment)` Send the crop Intent from a Fragment
`void`	`start(android.content.Context context, android.app.Fragment fragment, int requestCode)` Send the crop Intent with a custom request code
`UCrop`	`useSourceImageAspectRatio()` Set an aspect ratio for crop bounds that is evaluated from source image width and height.
`UCrop`	`withAspectRatio(float x, float y)` Set an aspect ratio for crop bounds.
`UCrop`	`withMaxResultSize(int width, int height)` Set maximum size for result cropped image.
`UCrop`	`withOptions(UCrop.Options options)`

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

- Field Detail
  - REQUEST_CROP
```
public static final int REQUEST_CROP
```
    See Also:
    
    Constant Field Values
  - RESULT_ERROR
```
public static final int RESULT_ERROR
```
    See Also:
    
    Constant Field Values
  - EXTRA_INPUT_URI
```
public static final java.lang.String EXTRA_INPUT_URI
```
  - EXTRA_OUTPUT_URI
```
public static final java.lang.String EXTRA_OUTPUT_URI
```
  - EXTRA_OUTPUT_CROP_ASPECT_RATIO
```
public static final java.lang.String EXTRA_OUTPUT_CROP_ASPECT_RATIO
```
  - EXTRA_OUTPUT_IMAGE_WIDTH
```
public static final java.lang.String EXTRA_OUTPUT_IMAGE_WIDTH
```
  - EXTRA_OUTPUT_IMAGE_HEIGHT
```
public static final java.lang.String EXTRA_OUTPUT_IMAGE_HEIGHT
```
  - EXTRA_OUTPUT_OFFSET_X
```
public static final java.lang.String EXTRA_OUTPUT_OFFSET_X
```
  - EXTRA_OUTPUT_OFFSET_Y
```
public static final java.lang.String EXTRA_OUTPUT_OFFSET_Y
```
  - EXTRA_ERROR
```
public static final java.lang.String EXTRA_ERROR
```
  - EXTRA_ASPECT_RATIO_X
```
public static final java.lang.String EXTRA_ASPECT_RATIO_X
```
  - EXTRA_ASPECT_RATIO_Y
```
public static final java.lang.String EXTRA_ASPECT_RATIO_Y
```
  - EXTRA_MAX_SIZE_X
```
public static final java.lang.String EXTRA_MAX_SIZE_X
```
  - EXTRA_MAX_SIZE_Y
```
public static final java.lang.String EXTRA_MAX_SIZE_Y
```
- Method Detail
  - of
```
public static UCrop of(android.net.Uri source,
                       android.net.Uri destination)
```
    This method creates new Intent builder and sets both source and destination image URIs.
    
    Parameters:
    
    source - Uri for image to crop
    
    destination - Uri for saving the cropped image
  - withAspectRatio
```
public UCrop withAspectRatio(float x,
                             float y)
```
    Set an aspect ratio for crop bounds. User won't see the menu with other ratios options.
    
    Parameters:
    
    x - aspect ratio X
    
    y - aspect ratio Y
  - useSourceImageAspectRatio
```
public UCrop useSourceImageAspectRatio()
```
    Set an aspect ratio for crop bounds that is evaluated from source image width and height. User won't see the menu with other ratios options.
  - withMaxResultSize
```
public UCrop withMaxResultSize(int width,
                               int height)
```
    Set maximum size for result cropped image.
    
    Parameters:
    
    width - max cropped image width
    
    height - max cropped image height
  - withOptions
```
public UCrop withOptions(UCrop.Options options)
```
  - start
```
public void start(android.app.Activity activity)
```
    Send the crop Intent from an Activity
    
    Parameters:
    
    activity - Activity to receive result
  - start
```
public void start(android.app.Activity activity,
                  int requestCode)
```
    Send the crop Intent from an Activity with a custom request code
    
    Parameters:
    
    activity - Activity to receive result
    
    requestCode - requestCode for result
  - start
```
public void start(android.content.Context context,
                  android.app.Fragment fragment)
```
    Send the crop Intent from a Fragment
    
    Parameters:
    
    fragment - Fragment to receive result
  - start
```
public void start(android.content.Context context,
                  android.support.v4.app.Fragment fragment)
```
    Send the crop Intent from a support library Fragment
    
    Parameters:
    
    fragment - Fragment to receive result
  - start
```
public void start(android.content.Context context,
                  android.app.Fragment fragment,
                  int requestCode)
```
    Send the crop Intent with a custom request code
    
    Parameters:
    
    fragment - Fragment to receive result
    
    requestCode - requestCode for result
  - start
```
public void start(android.content.Context context,
                  android.support.v4.app.Fragment fragment,
                  int requestCode)
```
    Send the crop Intent with a custom request code
    
    Parameters:
    
    fragment - Fragment to receive result
    
    requestCode - requestCode for result
  - getIntent
```
public android.content.Intent getIntent(android.content.Context context)
```
    Get Intent to start UCropActivity
    
    Returns:
    
    Intent for UCropActivity
  - getOutput
```
public static android.net.Uri getOutput(android.content.Intent intent)
```
    Retrieve cropped image Uri from the result Intent
    
    Parameters:
    
    intent - crop result intent
  - getOutputImageWidth
```
public static int getOutputImageWidth(android.content.Intent intent)
```
    Retrieve the width of the cropped image
    
    Parameters:
    
    intent - crop result intent
  - getOutputImageHeight
```
public static int getOutputImageHeight(android.content.Intent intent)
```
    Retrieve the height of the cropped image
    
    Parameters:
    
    intent - crop result intent
  - getOutputCropAspectRatio
```
public static float getOutputCropAspectRatio(android.content.Intent intent)
```
    Retrieve cropped image aspect ratio from the result Intent
    
    Parameters:
    
    intent - crop result intent
    
    Returns:
    
    aspect ratio as a floating point value (x:y) - so it will be 1 for 1:1 or 4/3 for 4:3
  - getError
```
public static java.lang.Throwable getError(android.content.Intent result)
```
    Method retrieves error from the result intent.
    
    Parameters:
    
    result - crop result Intent
    
    Returns:
    
    Throwable that could happen while image processing

Class UCrop

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

REQUEST_CROP

RESULT_ERROR

EXTRA_INPUT_URI

EXTRA_OUTPUT_URI

EXTRA_OUTPUT_CROP_ASPECT_RATIO

EXTRA_OUTPUT_IMAGE_WIDTH

EXTRA_OUTPUT_IMAGE_HEIGHT

EXTRA_OUTPUT_OFFSET_X

EXTRA_OUTPUT_OFFSET_Y

EXTRA_ERROR

EXTRA_ASPECT_RATIO_X

EXTRA_ASPECT_RATIO_Y

EXTRA_MAX_SIZE_X

EXTRA_MAX_SIZE_Y

Method Detail

of

withAspectRatio

useSourceImageAspectRatio

withMaxResultSize

withOptions

start

start

start

start

start

start

getIntent

getOutput

getOutputImageWidth

getOutputImageHeight

getOutputCropAspectRatio

getError