com.mgz.afp.foca

Enum CPC_CodePageControl.CodePageUseFlag

java.lang.Object

java.lang.Enum<CPC_CodePageControl.CodePageUseFlag>

com.mgz.afp.foca.CPC_CodePageControl.CodePageUseFlag

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CPC_CodePageControl.CodePageUseFlag>

Enclosing class:

CPC_CodePageControl

public static enum CPC_CodePageControl.CodePageUseFlag
extends java.lang.Enum<CPC_CodePageControl.CodePageUseFlag>

Enum Constant Summary

Enum Constants

Enum Constant and Description
SortOrder When this flag bit is set to B'1' (on), the CPI repeating groups are sorted in ascending code point order.
VariableSpaceEnable This flag is used to enable variable spacing.

Method Summary

Modifier and Type	Method and Description
static int	toByte(java.util.EnumSet<CPC_CodePageControl.CodePageUseFlag> flags)
static java.util.EnumSet<CPC_CodePageControl.CodePageUseFlag>	valueOf(int flagByte)
static CPC_CodePageControl.CodePageUseFlag	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CPC_CodePageControl.CodePageUseFlag[]	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

SortOrder

public static final CPC_CodePageControl.CodePageUseFlag SortOrder

When this flag bit is set to B'1' (on), the CPI repeating groups are sorted in ascending code point order. When this flag bit is set to B'0' (off), the CPI repeating groups are sorted in ascending character ID order.

VariableSpaceEnable

public static final CPC_CodePageControl.CodePageUseFlag VariableSpaceEnable

This flag is used to enable variable spacing. When the flag is set, the PTOCA variable space increment is used whenever the code point for the variable space character is encountered. Some AFP products, such as DCF, use variable spacing for text justification and therefore require this flag to be set. When the flag is not set, all PTOCA SVI control sequences are ignored and the space character is printed as defined in the accompanying font whenever the variable space code point is encountered. If a code page is built that has this flag not set, it should not be used with AFP products that require the variable space function.

Method Detail

values

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

Returns:

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

valueOf

public static CPC_CodePageControl.CodePageUseFlag 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

java.lang.NullPointerException - if the argument is null

valueOf

public static java.util.EnumSet<CPC_CodePageControl.CodePageUseFlag> valueOf(int flagByte)

toByte

public static int toByte(java.util.EnumSet<CPC_CodePageControl.CodePageUseFlag> flags)