Home

Awesome

This repository is deprecated and will be maintained no more.

PhotoCropper

Download

PhotoCropper is a light-weight but sharp and smart tool to help you cropping photos on android devices. By providing a simple callback interface for developers and encapsulating the tricky things of cropping photos into a library. It makes the logic much more easier and simpler.

If you want to learn more details about this, my blogs might help you.

Sample

photo cropper demonstration

Usage

It's really easy to use, but always remember:

IMPORTANT NOTICE!

Always clear your cached cropped images from last time.

// MUST!! Clear Last Cached Image
CropHelper.clearCachedCropFile(mCropParams.uri);

startActivityForResult(CropHelper.buildCropFromGalleryIntent(mCropParams), CropHelper.REQUEST_CROP);

Step 1

First you need a CropHandler to handle the activity results of cropping photos.

@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
    super.onActivityResult(requestCode, resultCode, data);
    CropHelper.handleResult(cropHandler, requestCode, resultCode, data);
}

Step 2

Make sure you implemented these methods:

@Override
public void onPhotoCropped(Uri uri) {
    // The cropped result
    // uri relates to the cropped photo
    // ...
}

@Override
public Activity getContext() {
    // MUST NOT be null
    return mContext;
}

@Override
public CropParams getCropParams() {
    // Your own crop options, simply call new CropParams() will give you a set of default crop options 
    mCropParams = new CropParams();
    return mCropParams;
}

@Override
public void onCropFailed(String message) {
    // ...
}

@Override
public void onCropCancel() {
    // ...
}

Step 3

Launch a request to crop photos.

Crop from camera

Intent intent = CropHelper.buildCaptureIntent(mCropParams.uri);
startActivityForResult(intent, CropHelper.REQUEST_CAMERA);

Crop from gallery

Intent intent = CropHelper.buildCropFromGalleryIntent(mCropParams);
startActivityForResult(intent, CropHelper.REQUEST_CROP);

Step 4

Clear the cached image if possible.

@Override
protected void onDestroy() {
    if (cropHandler.getCropParams() != null)
        CropHelper.clearCachedCropFile(cropHandler.getCropParams().uri);
    super.onDestroy();
}

Dependency Support

Gradle

compile 'org.hybridsquad.android.photocropper:library:2.1.0'

Maven

<dependency>
        <groupId>org.hybridsquad.android.photocropper</groupId>
        <artifactId>library</artifactId>
        <version>2.1.0</version>
        <type>jar</type>
        <classifier>sources</classifier>
</dependency>

LICENSE

The MIT License (MIT)

Copyright (c) 2014 Ryan Hoo

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.