com.theartofdev.edmodo.cropper

Enum Edge

java.lang.Object

java.lang.Enum<Edge>

com.theartofdev.edmodo.cropper.Edge

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Edge>

public enum Edge
extends java.lang.Enum<Edge>

Enum representing an edge in the crop window.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTTOM
LEFT
RIGHT
TOP

Field Summary

Fields

Modifier and Type	Field and Description
static int	MIN_CROP_HORIZONTAL_LENGTH Minimum distance in pixels that one edge can get to its opposing edge.
static int	MIN_CROP_VERTICAL_LENGTH Minimum distance in pixels that one edge can get to its opposing edge.

Method Summary

Modifier and Type	Method and Description
void	adjustCoordinate(float aspectRatio) Adjusts this Edge position such that the resulting window will have the given aspect ratio.
void	adjustCoordinate(float x, float y, android.graphics.Rect imageRect, float imageSnapRadius, float aspectRatio) Sets the Edge to the given x-y coordinate but also adjusting for snapping to the image bounds and parent view border constraints.
float	getCoordinate() Gets the coordinate of the Edge
static float	getHeight() Gets the current height of the crop window.
static float	getWidth() Gets the current width of the crop window.
boolean	isNewRectangleOutOfBounds(Edge edge, android.graphics.Rect imageRect, float aspectRatio) Returns whether or not you can re-scale the image based on whether any edge would be out of bounds.
boolean	isOutsideFrame(android.graphics.Rect rect) Determines if this Edge is outside the image frame of the given bounding rectangle.
boolean	isOutsideMargin(android.graphics.Rect rect, float margin) Determines if this Edge is outside the inner margins of the given bounding rectangle.
void	offset(float distance) Add the given number of pixels to the current coordinate position of this Edge.
void	setCoordinate(float coordinate) Sets the coordinate of the Edge.
float	snapOffset(android.graphics.Rect imageRect) Returns the potential snap offset of snaptoRect, without changing the coordinate.
float	snapToRect(android.graphics.Rect imageRect) Snap this Edge to the given image boundaries.
void	snapToView(android.view.View view) Snap this Edge to the given View boundaries.
static Edge	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Edge[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LEFT

public static final Edge LEFT

TOP

public static final Edge TOP

RIGHT

public static final Edge RIGHT

BOTTOM

public static final Edge BOTTOM

Field Detail

MIN_CROP_VERTICAL_LENGTH

public static final int MIN_CROP_VERTICAL_LENGTH

Minimum distance in pixels that one edge can get to its opposing edge.

See Also:

Constant Field Values

MIN_CROP_HORIZONTAL_LENGTH

public static final int MIN_CROP_HORIZONTAL_LENGTH

Minimum distance in pixels that one edge can get to its opposing edge.

See Also:

Constant Field Values

Method Detail

values

public static Edge[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Edge c : Edge.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Edge valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

setCoordinate

public void setCoordinate(float coordinate)

Sets the coordinate of the Edge. The coordinate will represent the x-coordinate for LEFT and RIGHT Edges and the y-coordinate for TOP and BOTTOM edges.

Parameters:

coordinate - the position of the edge

offset

public void offset(float distance)

Add the given number of pixels to the current coordinate position of this Edge.

Parameters:

distance - the number of pixels to add

getCoordinate

public float getCoordinate()

Gets the coordinate of the Edge

Returns:

the Edge coordinate (x-coordinate for LEFT and RIGHT Edges and the y-coordinate for TOP and BOTTOM edges)

adjustCoordinate

public void adjustCoordinate(float x,
                             float y,
                             android.graphics.Rect imageRect,
                             float imageSnapRadius,
                             float aspectRatio)

Sets the Edge to the given x-y coordinate but also adjusting for snapping to the image bounds and parent view border constraints.

Parameters:

x - the x-coordinate

y - the y-coordinate

imageRect - the bounding rectangle of the image

imageSnapRadius - the radius (in pixels) at which the edge should snap to the image

adjustCoordinate

public void adjustCoordinate(float aspectRatio)

Adjusts this Edge position such that the resulting window will have the given aspect ratio.

Parameters:

aspectRatio - the aspect ratio to achieve

isNewRectangleOutOfBounds

public boolean isNewRectangleOutOfBounds(Edge edge,
                                         android.graphics.Rect imageRect,
                                         float aspectRatio)

Returns whether or not you can re-scale the image based on whether any edge would be out of bounds. Checks all the edges for a possibility of jumping out of bounds.

Parameters:

edge - the Edge that is about to be expanded

imageRect - the rectangle of the picture

aspectRatio - the desired aspectRatio of the picture.

Returns:

whether or not the new image would be out of bounds.

snapToRect

public float snapToRect(android.graphics.Rect imageRect)

Snap this Edge to the given image boundaries.

Parameters:

imageRect - the bounding rectangle of the image to snap to

Returns:

the amount (in pixels) that this coordinate was changed (i.e. the new coordinate minus the old coordinate value)

snapOffset

public float snapOffset(android.graphics.Rect imageRect)

Returns the potential snap offset of snaptoRect, without changing the coordinate.

Parameters:

imageRect - the bounding rectangle of the image to snap to

Returns:

the amount (in pixels) that this coordinate was changed (i.e. the new coordinate minus the old coordinate value)

snapToView

public void snapToView(android.view.View view)

Snap this Edge to the given View boundaries.

Parameters:

view - the View to snap to

getWidth

public static float getWidth()

Gets the current width of the crop window.

getHeight

public static float getHeight()

Gets the current height of the crop window.

isOutsideMargin

public boolean isOutsideMargin(android.graphics.Rect rect,
                               float margin)

Determines if this Edge is outside the inner margins of the given bounding rectangle. The margins come inside the actual frame by SNAPRADIUS amount; therefore, determines if the point is outside the inner "margin" frame.

isOutsideFrame

public boolean isOutsideFrame(android.graphics.Rect rect)

Determines if this Edge is outside the image frame of the given bounding rectangle.