org.alembik.util
Enum TranscodingUtils.TextOverlayOrientation

java.lang.Object
  java.lang.Enum<TranscodingUtils.TextOverlayOrientation>
      org.alembik.util.TranscodingUtils.TextOverlayOrientation

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TranscodingUtils.TextOverlayOrientation>

Enclosing class:

TranscodingUtils

public static enum TranscodingUtils.TextOverlayOrientation
extends java.lang.Enum<TranscodingUtils.TextOverlayOrientation>

The acceptable values of the TranscodingUtils.TextOverlayAttr.ORIENTATION attribute of the TextOverlay transformation.

See Also:

TranscodingUtils.TRANSFORMATION_TEXT_OVERLAY, TranscodingUtils.TextOverlayAttr, TranscodingUtils.TextOverlayFont, TranscodingUtils.setImageTextOverlay(TranscodingJob, String, org.alembik.util.TranscodingUtils.TextOverlayFont)

Enum Constant Summary

DIAGONAL
Diagonal orientation.

HORIZONTAL
Horizontal orientation.

LOW_BANNER
"Low banner" orientation.

Method Summary

java.lang.String	getName() Returns the identifier of the font/text orientation.
static TranscodingUtils.TextOverlayOrientation	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TranscodingUtils.TextOverlayOrientation[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HORIZONTAL

public static final TranscodingUtils.TextOverlayOrientation HORIZONTAL

Horizontal orientation.

DIAGONAL

public static final TranscodingUtils.TextOverlayOrientation DIAGONAL

Diagonal orientation.

LOW_BANNER

public static final TranscodingUtils.TextOverlayOrientation LOW_BANNER

"Low banner" orientation.

Method Detail

values

public static final TranscodingUtils.TextOverlayOrientation[] values()

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

for(TranscodingUtils.TextOverlayOrientation c : TranscodingUtils.TextOverlayOrientation.values())
        System.out.println(c);

Returns:

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

valueOf

public static TranscodingUtils.TextOverlayOrientation 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

getName

public java.lang.String getName()

Returns the identifier of the font/text orientation.

Returns:

font/text orientation id