Package com.microblink.photopay.uisettings.options

Enum Class OverlayOrientation

java.lang.Object

java.lang.Enum<OverlayOrientation>

com.microblink.photopay.uisettings.options.OverlayOrientation

All Implemented Interfaces:

Serializable, Comparable<OverlayOrientation>, Constable

public enum OverlayOrientation
extends Enum<OverlayOrientation>

Orientation of the rotatable views in camera overlay.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
LANDSCAPE	Allowed orientations will be Orientation.ORIENTATION_LANDSCAPE_RIGHT or Orientation.ORIENTATION_LANDSCAPE_LEFT.
PORTRAIT	Allowed orientations will be Orientation.ORIENTATION_PORTRAIT or Orientation.ORIENTATION_PORTRAIT_UPSIDE.

Method Summary

Modifier and Type	Method	Description
int	toActivityInfoOrientation()	Helper method to convert OverlayOrientation to ActivityInfo constant.
Orientation	toOrientation()	Helper method to convert OverlayOrientation to Orientation.
static OverlayOrientation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OverlayOrientation[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PORTRAIT

public static final OverlayOrientation PORTRAIT

Allowed orientations will be Orientation.ORIENTATION_PORTRAIT or Orientation.ORIENTATION_PORTRAIT_UPSIDE.

LANDSCAPE

public static final OverlayOrientation LANDSCAPE

Allowed orientations will be Orientation.ORIENTATION_LANDSCAPE_RIGHT or Orientation.ORIENTATION_LANDSCAPE_LEFT.

Method Details

values

public static OverlayOrientation[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static OverlayOrientation valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

toActivityInfoOrientation

public int toActivityInfoOrientation()

Helper method to convert OverlayOrientation to ActivityInfo constant.

Returns:

ActivityInfo constant that represents enum.

toOrientation

@NonNull
public Orientation toOrientation()

Helper method to convert OverlayOrientation to Orientation.

Returns:

OverlayOrientation that represents enum.