Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation fixes. #388

Merged
merged 1 commit into from
Jun 17, 2022
Merged

Documentation fixes. #388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion cropper/src/main/java/com/canhub/cropper/CropImageOptions.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ open class CropImageOptions : Parcelable {
@JvmField
var multiTouchEnabled: Boolean

/** if the the crop window can be moved by dragging the center; default: true */
/** if the crop window can be moved by dragging the center; default: true */
@JvmField
var centerMoveEnabled: Boolean

Expand Down
50 changes: 13 additions & 37 deletions cropper/src/main/java/com/canhub/cropper/CropImageView.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,18 +79,7 @@ class CropImageView @JvmOverloads constructor(context: Context, attrs: Attribute

/** The initial scale type of the image in the crop image view */
private var mScaleType: ScaleType
/**
* if to save bitmap on save instance state.<br></br>
* It is best to avoid it by using URI in setting image for cropping.<br></br>
* If false the bitmap is not saved and if restore is required to view will be empty, storing the
* bitmap requires saving it to file which can be expensive. default: false.
*/
/**
* if to save bitmap on save instance state.<br></br>
* It is best to avoid it by using URI in setting image for cropping.<br></br>
* If false the bitmap is not saved and if restore is required to view will be empty, storing the
* bitmap requires saving it to file which can be expensive. default: false.
*/

/**
* if to save bitmap on save instance state.<br></br>
* It is best to avoid it by using URI in setting image for cropping.<br></br>
Expand Down Expand Up @@ -191,8 +180,8 @@ class CropImageView @JvmOverloads constructor(context: Context, attrs: Attribute

/** Task used to crop bitmap async from UI thread */
private var bitmapCroppingWorkerJob: WeakReference<BitmapCroppingWorkerJob>? = null
/** Get the scale type of the image in the crop view. */
/** Set the scale type of the image in the crop view */

/** Get / set the scale type of the image in the crop view. */
var scaleType: ScaleType
get() = mScaleType
set(scaleType) {
Expand All @@ -205,7 +194,7 @@ class CropImageView @JvmOverloads constructor(context: Context, attrs: Attribute
requestLayout()
}
}
/** The shape of the cropping area - rectangle/circular. */

/**
* The shape of the cropping area - rectangle/circular.<br></br>
* To set square/circle crop shape set aspect ratio to 1:1.
Expand All @@ -223,6 +212,7 @@ class CropImageView @JvmOverloads constructor(context: Context, attrs: Attribute
set(cropShape) {
mCropOverlayView!!.setCropShape(cropShape!!)
}

/**
* The shape of the crop corner in the crop overlay (Rectangular / Circular)
*/
Expand All @@ -232,7 +222,6 @@ class CropImageView @JvmOverloads constructor(context: Context, attrs: Attribute
mCropOverlayView!!.setCropCornerShape(cornerShape!!)
}

/** if auto-zoom functionality is enabled. default: true. */
/** Set auto-zoom functionality to enabled/disabled. */
var isAutoZoomEnabled: Boolean
get() = mAutoZoomEnabled
Expand All @@ -244,7 +233,7 @@ class CropImageView @JvmOverloads constructor(context: Context, attrs: Attribute
}
}

/** Set multi touch functionality to enabled/disabled. */
/** Set multi-touch functionality to enabled/disabled. */
fun setMultiTouchEnabled(multiTouchEnabled: Boolean) {
if (mCropOverlayView!!.setMultiTouchEnabled(multiTouchEnabled)) {
handleCropWindowChanged(inProgress = false, animate = false)
Expand All @@ -259,7 +248,7 @@ class CropImageView @JvmOverloads constructor(context: Context, attrs: Attribute
mCropOverlayView.invalidate()
}
}
/** The max zoom allowed during cropping. */

/** The max zoom allowed during cropping. */
var maxZoom: Int
get() = mMaxZoom
Expand All @@ -286,15 +275,9 @@ class CropImageView @JvmOverloads constructor(context: Context, attrs: Attribute
fun setMaxCropResultSize(maxCropResultWidth: Int, maxCropResultHeight: Int) {
mCropOverlayView!!.setMaxCropResultSize(maxCropResultWidth, maxCropResultHeight)
}

/**
* Get the amount of degrees the cropping image is rotated clockwise.<br></br>
*
* @return 0-360
*/
/**
* Set the amount of degrees the cropping image is rotated clockwise.<br></br>
*
* degrees 0-360
* Set / Get the amount of degrees (between 0 and 360) the cropping image is rotated clockwise.<br></br>
*/
var rotatedDegrees: Int
get() = mDegreesRotated
Expand All @@ -318,7 +301,7 @@ class CropImageView @JvmOverloads constructor(context: Context, attrs: Attribute
fun setFixedAspectRatio(fixAspectRatio: Boolean) {
mCropOverlayView!!.setFixedAspectRatio(fixAspectRatio)
}
/** whether the image should be flipped horizontally */

/** Sets whether the image should be flipped horizontally */
var isFlippedHorizontally: Boolean
get() = mFlipHorizontally
Expand All @@ -335,7 +318,7 @@ class CropImageView @JvmOverloads constructor(context: Context, attrs: Attribute
}
/** the Android Uri to save the cropped image to */
var customOutputUri: Uri? = null
/** whether the image should be flipped vertically */

/** Sets whether the image should be flipped vertically */
var isFlippedVertically: Boolean
get() = mFlipVertically
Expand Down Expand Up @@ -393,10 +376,7 @@ class CropImageView @JvmOverloads constructor(context: Context, attrs: Attribute
fun setSnapRadius(snapRadius: Float) {
if (snapRadius >= 0) mCropOverlayView!!.setSnapRadius(snapRadius)
}
/**
* if to show progress bar when image async loading/cropping is in progress.<br></br>
* default: true, disable to provide custom progress bar UI.
*/

/**
* if to show progress bar when image async loading/cropping is in progress.<br></br>
* default: true, disable to provide custom progress bar UI.
Expand All @@ -409,11 +389,7 @@ class CropImageView @JvmOverloads constructor(context: Context, attrs: Attribute
setProgressBarVisibility()
}
}
/**
* if to show crop overlay UI what contains the crop window UI surrounded by background over the
* cropping image.<br></br>
* default: true, may disable for animation or frame transition.
*/

/**
* if to show crop overlay UI what contains the crop window UI surrounded by background over the
* cropping image.<br></br>
Expand Down