org.sejda.model.pdf.viewerpreference

Enum PdfDirection

java.lang.Object

java.lang.Enum<PdfDirection>

org.sejda.model.pdf.viewerpreference.PdfDirection

All Implemented Interfaces:

Serializable, Comparable<PdfDirection>, FriendlyNamed, MinRequiredVersion

public enum PdfDirection
extends Enum<PdfDirection>
implements MinRequiredVersion, FriendlyNamed

Possible values for the predominant reading order for text.
Pdf reference 1.7, TABLE 8.1 Entries in a viewer preferences dictionary

Author:

Andrea Vacondio

Enum Constant Summary

Enum Constants

Enum Constant and Description
LEFT_TO_RIGHT
RIGHT_TO_LEFT

Method Summary

Methods

Modifier and Type	Method and Description
String	getFriendlyName()
PdfVersion	getMinVersion()
static PdfDirection	valueOf(String name) Returns the enum constant of this type with the specified name.
static PdfDirection[]	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_TO_RIGHT

public static final PdfDirection LEFT_TO_RIGHT

RIGHT_TO_LEFT

public static final PdfDirection RIGHT_TO_LEFT

Method Detail

values

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

Returns:

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

valueOf

public static PdfDirection 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

getFriendlyName

public String getFriendlyName()

Specified by:

getFriendlyName in interface FriendlyNamed

Returns:

the friendly name of the entity, to be usually used as a representation for an user.

getMinVersion

public PdfVersion getMinVersion()

Specified by:

getMinVersion in interface MinRequiredVersion

Returns:

the minimum required version