org.sejda.model.repaginate

Enum Repagination

java.lang.Object

java.lang.Enum<Repagination>

org.sejda.model.repaginate.Repagination

All Implemented Interfaces:

Serializable, Comparable<Repagination>, FriendlyNamed

public enum Repagination
extends Enum<Repagination>
implements FriendlyNamed

Enum Constant Summary

Enum Constants

Enum Constant and Description
LAST_FIRST This repagination is useful in scenarios such as two page layout scans from unstapled booklets (staples removed from the booklet and then the double pages scanned front/back) First scanned page contains the last and first covers (hence the name), second scanned page contains second and before-last page, and so on.
NONE

Method Summary

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

LAST_FIRST

public static final Repagination LAST_FIRST

This repagination is useful in scenarios such as two page layout scans from unstapled booklets (staples removed from the booklet and then the double pages scanned front/back) First scanned page contains the last and first covers (hence the name), second scanned page contains second and before-last page, and so on. Example for a 10 pages booklet scanned in this manner: (10,1) (2,9) (8,3) (4,7) (6,5) Splitting the two-page layout document down the middle would result in: 10,1,2,9,8,3,4,7,6,5 Applying the last-first repagination in this case would order the pages as a reader would expect them: 1,2,3,4,5,6,7,8,9,10

NONE

public static final Repagination NONE

Method Detail

values

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

Returns:

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

valueOf

public static Repagination 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.