com.yalantis.ucrop

Class UCrop.Options

java.lang.Object

com.yalantis.ucrop.UCrop.Options

Enclosing class:

UCrop

public static class UCrop.Options
extends java.lang.Object

Class that helps to setup advanced configs that are not commonly used. Use it with method UCrop.withOptions(Options)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXTRA_ALLOWED_GESTURES
static java.lang.String	EXTRA_ASPECT_RATIO_OPTIONS
static java.lang.String	EXTRA_ASPECT_RATIO_SELECTED_BY_DEFAULT
static java.lang.String	EXTRA_CIRCLE_DIMMED_LAYER
static java.lang.String	EXTRA_COMPRESSION_FORMAT_NAME
static java.lang.String	EXTRA_COMPRESSION_QUALITY
static java.lang.String	EXTRA_CROP_FRAME_COLOR
static java.lang.String	EXTRA_CROP_FRAME_STROKE_WIDTH
static java.lang.String	EXTRA_CROP_GRID_COLOR
static java.lang.String	EXTRA_CROP_GRID_COLUMN_COUNT
static java.lang.String	EXTRA_CROP_GRID_ROW_COUNT
static java.lang.String	EXTRA_CROP_GRID_STROKE_WIDTH
static java.lang.String	EXTRA_DIMMED_LAYER_COLOR
static java.lang.String	EXTRA_FREE_STYLE_CROP
static java.lang.String	EXTRA_HIDE_BOTTOM_CONTROLS
static java.lang.String	EXTRA_IMAGE_TO_CROP_BOUNDS_ANIM_DURATION
static java.lang.String	EXTRA_MAX_BITMAP_SIZE
static java.lang.String	EXTRA_MAX_SCALE_MULTIPLIER
static java.lang.String	EXTRA_SHOW_CROP_FRAME
static java.lang.String	EXTRA_SHOW_CROP_GRID
static java.lang.String	EXTRA_STATUS_BAR_COLOR
static java.lang.String	EXTRA_TOOL_BAR_COLOR
static java.lang.String	EXTRA_UCROP_COLOR_WIDGET_ACTIVE
static java.lang.String	EXTRA_UCROP_LOGO_COLOR
static java.lang.String	EXTRA_UCROP_ROOT_VIEW_BACKGROUND_COLOR
static java.lang.String	EXTRA_UCROP_TITLE_TEXT_TOOLBAR
static java.lang.String	EXTRA_UCROP_WIDGET_CANCEL_DRAWABLE
static java.lang.String	EXTRA_UCROP_WIDGET_COLOR_TOOLBAR
static java.lang.String	EXTRA_UCROP_WIDGET_CROP_DRAWABLE

Constructor Summary

Constructors

Constructor and Description
Options()

Method Summary

Modifier and Type	Method and Description
android.os.Bundle	getOptionBundle()
void	setActiveWidgetColor(int color)
void	setAllowedGestures(int tabScale, int tabRotate, int tabAspectRatio) Choose what set of gestures will be enabled on each tab - if any.
void	setAspectRatioOptions(int selectedByDefault, AspectRatio... aspectRatio) Pass an ordered list of desired aspect ratios that should be available for a user.
void	setCircleDimmedLayer(boolean isCircle)
void	setCompressionFormat(android.graphics.Bitmap.CompressFormat format) Set one of Bitmap.CompressFormat that will be used to save resulting Bitmap.
void	setCompressionQuality(int compressQuality) Set compression quality [0-100] that will be used to save resulting Bitmap.
void	setCropFrameColor(int color)
void	setCropFrameStrokeWidth(int width)
void	setCropGridColor(int color)
void	setCropGridColumnCount(int count)
void	setCropGridRowCount(int count)
void	setCropGridStrokeWidth(int width)
void	setDimmedLayerColor(int color)
void	setFreeStyleCropEnabled(boolean enabled)
void	setHideBottomControls(boolean hide)
void	setImageToCropBoundsAnimDuration(int durationMillis) This method sets animation duration for image to wrap the crop bounds
void	setLogoColor(int color)
void	setMaxBitmapSize(int maxBitmapSize) Setter for max size for both width and height of bitmap that will be decoded from an input Uri and used in the view.
void	setMaxScaleMultiplier(float maxScaleMultiplier) This method sets multiplier that is used to calculate max image scale from min image scale.
void	setRootViewBackgroundColor(int color)
void	setShowCropFrame(boolean show)
void	setShowCropGrid(boolean show)
void	setStatusBarColor(int color)
void	setToolbarCancelDrawable(int drawable)
void	setToolbarColor(int color)
void	setToolbarCropDrawable(int drawable)
void	setToolbarTitle(java.lang.String text)
void	setToolbarWidgetColor(int color)
void	useSourceImageAspectRatio() Set an aspect ratio for crop bounds that is evaluated from source image width and height.
void	withAspectRatio(float x, float y) Set an aspect ratio for crop bounds.
void	withMaxResultSize(int width, int height) Set maximum size for result cropped image.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXTRA_COMPRESSION_FORMAT_NAME

public static final java.lang.String EXTRA_COMPRESSION_FORMAT_NAME

EXTRA_COMPRESSION_QUALITY

public static final java.lang.String EXTRA_COMPRESSION_QUALITY

EXTRA_ALLOWED_GESTURES

public static final java.lang.String EXTRA_ALLOWED_GESTURES

EXTRA_MAX_BITMAP_SIZE

public static final java.lang.String EXTRA_MAX_BITMAP_SIZE

EXTRA_MAX_SCALE_MULTIPLIER

public static final java.lang.String EXTRA_MAX_SCALE_MULTIPLIER

EXTRA_IMAGE_TO_CROP_BOUNDS_ANIM_DURATION

public static final java.lang.String EXTRA_IMAGE_TO_CROP_BOUNDS_ANIM_DURATION

EXTRA_DIMMED_LAYER_COLOR

public static final java.lang.String EXTRA_DIMMED_LAYER_COLOR

EXTRA_CIRCLE_DIMMED_LAYER

public static final java.lang.String EXTRA_CIRCLE_DIMMED_LAYER

EXTRA_SHOW_CROP_FRAME

public static final java.lang.String EXTRA_SHOW_CROP_FRAME

EXTRA_CROP_FRAME_COLOR

public static final java.lang.String EXTRA_CROP_FRAME_COLOR

EXTRA_CROP_FRAME_STROKE_WIDTH

public static final java.lang.String EXTRA_CROP_FRAME_STROKE_WIDTH

EXTRA_SHOW_CROP_GRID

public static final java.lang.String EXTRA_SHOW_CROP_GRID

EXTRA_CROP_GRID_ROW_COUNT

public static final java.lang.String EXTRA_CROP_GRID_ROW_COUNT

EXTRA_CROP_GRID_COLUMN_COUNT

public static final java.lang.String EXTRA_CROP_GRID_COLUMN_COUNT

EXTRA_CROP_GRID_COLOR

public static final java.lang.String EXTRA_CROP_GRID_COLOR

EXTRA_CROP_GRID_STROKE_WIDTH

public static final java.lang.String EXTRA_CROP_GRID_STROKE_WIDTH

EXTRA_TOOL_BAR_COLOR

public static final java.lang.String EXTRA_TOOL_BAR_COLOR

EXTRA_STATUS_BAR_COLOR

public static final java.lang.String EXTRA_STATUS_BAR_COLOR

EXTRA_UCROP_COLOR_WIDGET_ACTIVE

public static final java.lang.String EXTRA_UCROP_COLOR_WIDGET_ACTIVE

EXTRA_UCROP_WIDGET_COLOR_TOOLBAR

public static final java.lang.String EXTRA_UCROP_WIDGET_COLOR_TOOLBAR

EXTRA_UCROP_TITLE_TEXT_TOOLBAR

public static final java.lang.String EXTRA_UCROP_TITLE_TEXT_TOOLBAR

EXTRA_UCROP_WIDGET_CANCEL_DRAWABLE

public static final java.lang.String EXTRA_UCROP_WIDGET_CANCEL_DRAWABLE

EXTRA_UCROP_WIDGET_CROP_DRAWABLE

public static final java.lang.String EXTRA_UCROP_WIDGET_CROP_DRAWABLE

EXTRA_UCROP_LOGO_COLOR

public static final java.lang.String EXTRA_UCROP_LOGO_COLOR

EXTRA_HIDE_BOTTOM_CONTROLS

public static final java.lang.String EXTRA_HIDE_BOTTOM_CONTROLS

EXTRA_FREE_STYLE_CROP

public static final java.lang.String EXTRA_FREE_STYLE_CROP

EXTRA_ASPECT_RATIO_SELECTED_BY_DEFAULT

public static final java.lang.String EXTRA_ASPECT_RATIO_SELECTED_BY_DEFAULT

EXTRA_ASPECT_RATIO_OPTIONS

public static final java.lang.String EXTRA_ASPECT_RATIO_OPTIONS

EXTRA_UCROP_ROOT_VIEW_BACKGROUND_COLOR

public static final java.lang.String EXTRA_UCROP_ROOT_VIEW_BACKGROUND_COLOR

Constructor Detail

Options

public Options()

Method Detail

getOptionBundle

public android.os.Bundle getOptionBundle()

setCompressionFormat

public void setCompressionFormat(android.graphics.Bitmap.CompressFormat format)

Set one of Bitmap.CompressFormat that will be used to save resulting Bitmap.

setCompressionQuality

public void setCompressionQuality(int compressQuality)

Set compression quality [0-100] that will be used to save resulting Bitmap.

setAllowedGestures

public void setAllowedGestures(int tabScale,
                               int tabRotate,
                               int tabAspectRatio)

Choose what set of gestures will be enabled on each tab - if any.

setMaxScaleMultiplier

public void setMaxScaleMultiplier(float maxScaleMultiplier)

This method sets multiplier that is used to calculate max image scale from min image scale.

Parameters:

maxScaleMultiplier - - (minScale * maxScaleMultiplier) = maxScale

setImageToCropBoundsAnimDuration

public void setImageToCropBoundsAnimDuration(int durationMillis)

This method sets animation duration for image to wrap the crop bounds

Parameters:

durationMillis - - duration in milliseconds

setMaxBitmapSize

public void setMaxBitmapSize(int maxBitmapSize)

Setter for max size for both width and height of bitmap that will be decoded from an input Uri and used in the view.

Parameters:

maxBitmapSize - - size in pixels

setDimmedLayerColor

public void setDimmedLayerColor(int color)

Parameters:

color - - desired color of dimmed area around the crop bounds

setCircleDimmedLayer

public void setCircleDimmedLayer(boolean isCircle)

Parameters:

isCircle - - set it to true if you want dimmed layer to have an circle inside

setShowCropFrame

public void setShowCropFrame(boolean show)

Parameters:

show - - set to true if you want to see a crop frame rectangle on top of an image

setCropFrameColor

public void setCropFrameColor(int color)

Parameters:

color - - desired color of crop frame

setCropFrameStrokeWidth

public void setCropFrameStrokeWidth(int width)

Parameters:

width - - desired width of crop frame line in pixels

setShowCropGrid

public void setShowCropGrid(boolean show)

Parameters:

show - - set to true if you want to see a crop grid/guidelines on top of an image

setCropGridRowCount

public void setCropGridRowCount(int count)

Parameters:

count - - crop grid rows count.

setCropGridColumnCount

public void setCropGridColumnCount(int count)

Parameters:

count - - crop grid columns count.

setCropGridColor

public void setCropGridColor(int color)

Parameters:

color - - desired color of crop grid/guidelines

setCropGridStrokeWidth

public void setCropGridStrokeWidth(int width)

Parameters:

width - - desired width of crop grid lines in pixels

setToolbarColor

public void setToolbarColor(int color)

Parameters:

color - - desired resolved color of the toolbar

setStatusBarColor

public void setStatusBarColor(int color)

Parameters:

color - - desired resolved color of the statusbar

setActiveWidgetColor

public void setActiveWidgetColor(int color)

Parameters:

color - - desired resolved color of the active and selected widget (default is orange) and progress wheel middle line

setToolbarWidgetColor

public void setToolbarWidgetColor(int color)

Parameters:

color - - desired resolved color of Toolbar text and buttons (default is darker orange)

setToolbarTitle

public void setToolbarTitle(java.lang.String text)

Parameters:

text - - desired text for Toolbar title

setToolbarCancelDrawable

public void setToolbarCancelDrawable(int drawable)

Parameters:

drawable - - desired drawable for the Toolbar left cancel icon

setToolbarCropDrawable

public void setToolbarCropDrawable(int drawable)

Parameters:

drawable - - desired drawable for the Toolbar right crop icon

setLogoColor

public void setLogoColor(int color)

Parameters:

color - - desired resolved color of logo fill (default is darker grey)

setHideBottomControls

public void setHideBottomControls(boolean hide)

Parameters:

hide - - set to true to hide the bottom controls (shown by default)

setFreeStyleCropEnabled

public void setFreeStyleCropEnabled(boolean enabled)

Parameters:

enabled - - set to true to let user resize crop bounds (disabled by default)

setAspectRatioOptions

public void setAspectRatioOptions(int selectedByDefault,
                                  AspectRatio... aspectRatio)

Pass an ordered list of desired aspect ratios that should be available for a user.

Parameters:

selectedByDefault - - index of aspect ratio option that is selected by default (starts with 0).

aspectRatio - - list of aspect ratio options that are available to user

setRootViewBackgroundColor

public void setRootViewBackgroundColor(int color)

Parameters:

color - - desired background color that should be applied to the root view

withAspectRatio

public void 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 void 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 void withMaxResultSize(int width,
                              int height)

Set maximum size for result cropped image.

Parameters:

width - max cropped image width

height - max cropped image height