Package com.digimarc.dis

Enum Class DMSDetectorView.OverlayType

java.lang.Object

java.lang.Enum<DMSDetectorView.OverlayType>

com.digimarc.dis.DMSDetectorView.OverlayType

All Implemented Interfaces:

Serializable, Comparable<DMSDetectorView.OverlayType>, Constable

Enclosing class:

DMSDetectorView

public static enum DMSDetectorView.OverlayType
extends Enum<DMSDetectorView.OverlayType>

Overlay types that can be set using the DMSDetectorView.setOverlayType(OverlayType) method.

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
Crosshairs	Show crosshairs centered on the current read region.
DetectRegion	Show the image detection region as a highlighted area on the screen.
None	Hide the existing overlay.

Method Summary

Modifier and Type	Method	Description
static DMSDetectorView.OverlayType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DMSDetectorView.OverlayType[]	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

None

public static final DMSDetectorView.OverlayType None

Hide the existing overlay. This should be used instead of the deprecated DMSDetectorView.setShowAimingView(boolean) (int)} or DMSDetectorView.showDetectRegion(Context, boolean) methods.

Crosshairs

public static final DMSDetectorView.OverlayType Crosshairs

Show crosshairs centered on the current read region. Crosshair is the default type of overlay and will be shown on startup.

DetectRegion

public static final DMSDetectorView.OverlayType DetectRegion

Show the image detection region as a highlighted area on the screen.

Method Details

values

public static DMSDetectorView.OverlayType[] 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 DMSDetectorView.OverlayType 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