ws.schild.jave.filters.helpers

Enum OverlayLocation

java.lang.Object

java.lang.Enum<OverlayLocation>

ws.schild.jave.filters.helpers.OverlayLocation

All Implemented Interfaces:

Serializable, Comparable<OverlayLocation>

public enum OverlayLocation
extends Enum<OverlayLocation>

Use this class to specify the starting location of your overlay. This accounts for video and overlay dimensions and still allows for relative offset.

Author:

mressler

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTTOM_LEFT
BOTTOM_RIGHT
TOP_LEFT
TOP_RIGHT

Method Summary

Modifier and Type	Method and Description
String	getExpression(Optional<Integer> offsetX, Optional<Integer> offsetY)
String	getX(Optional<Integer> offset)
String	getY(Optional<Integer> offset)
static OverlayLocation	valueOf(String name) Returns the enum constant of this type with the specified name.
static OverlayLocation[]	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

TOP_LEFT

public static final OverlayLocation TOP_LEFT

TOP_RIGHT

public static final OverlayLocation TOP_RIGHT

BOTTOM_RIGHT

public static final OverlayLocation BOTTOM_RIGHT

BOTTOM_LEFT

public static final OverlayLocation BOTTOM_LEFT

Method Detail

values

public static OverlayLocation[] 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 (OverlayLocation c : OverlayLocation.values())
    System.out.println(c);

Returns:

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

valueOf

public static OverlayLocation valueOf(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:

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

NullPointerException - if the argument is null

getExpression

public String getExpression(Optional<Integer> offsetX,
                            Optional<Integer> offsetY)

getX

public String getX(Optional<Integer> offset)

getY

public String getY(Optional<Integer> offset)