com.mgz.afp.enums

Enum SFType

java.lang.Object

java.lang.Enum<SFType>

com.mgz.afp.enums.SFType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SFType>

public enum SFType
extends java.lang.Enum<SFType>

The structured field type code. The type code identifies the function of the structured field, such as begin, end, descriptor, or data. See “Type Codes” on page 22 for a description of type codes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Attribute An attribute structured field such as name and value defines an attribute with parameters.
Begin A begin structured field introduces and identifies a document component.
Control A control structured field specifies the type of modifications that are to be applied to a group of sheet copies, or a copy subgroup.
CopyCount_PatternsMap A copy count structured field specifies groups of sheet copies, called copy subgroups, that are to be generated, and identifies modification control structured fields that specify modifications to be applied to each group.
Data A data structured field consists of data whose meaning and interpretation is governed by the object architecture for the particular data object type.
Descriptor A descriptor structured field defines the initial characteristics and, optionally, the formatting directives for all objects, object areas, and pages.
End An end structured field identifies the end of a document component.
Include An include structured field selects a named resource which is to be embedded in the including data stream as if it appeared inline.
Index FOCA ???
Link A link structured field defines a logical connection, or linkage, between two document components.
Map A map structured field provides the following functions in the MO:DCA architecture:All occurrences of a variable embedded in structured field parameter data can be given a new value by changing only one reference in the mapping, rather than having to physically change each occurrence.
Migration A migration structured field is used to distinguish the MO:DCA structured field from a structured field with the same acronym from an earlier data-stream architecture.
Orientation FOCA ???
Position A position structured field specifies the coordinate offset value and orientation for presentation spaces.
Process A process structured field specifies processing to be performed on an object.
Reserved See MO:DCA-L: The OS/2 Presentation Manager Metafile (.met) Format.
Size ???
Undefined Indicates that the SFType is unknown.
Variable A variable structured field defines or contains variable information.

Method Summary

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

Undefined

public static final SFType Undefined

Indicates that the SFType is unknown.

Index

public static final SFType Index

FOCA ???

Attribute

public static final SFType Attribute

An attribute structured field such as name and value defines an attribute with parameters.

CopyCount_PatternsMap

public static final SFType CopyCount_PatternsMap

A copy count structured field specifies groups of sheet copies, called copy subgroups, that are to be generated, and identifies modification control structured fields that specify modifications to be applied to each group.

Descriptor

public static final SFType Descriptor

A descriptor structured field defines the initial characteristics and, optionally, the formatting directives for all objects, object areas, and pages. Depending on the specific descriptor structured field type, it may contain some set of parameters that identify:

• The size of the page or object
• Measurement units
• Initial presentation conditions

Control

public static final SFType Control

A control structured field specifies the type of modifications that are to be applied to a group of sheet copies, or a copy subgroup.

Begin

public static final SFType Begin

A begin structured field introduces and identifies a document component. In general, a begin structured field may contain a parameter that identifies the name of the component.

End

public static final SFType End

An end structured field identifies the end of a document component. In general, an end structured field may contain a parameter that identifies the name of the component.

Size

public static final SFType Size

???

Map

public static final SFType Map

A map structured field provides the following functions in the MO:DCA architecture:

• All occurrences of a variable embedded in structured field parameter data can be given a new value by changing only one reference in the mapping, rather than having to physically change each occurrence. Thus all references to font X may cause a Times Roman font to be used in one instance and a Helvetica font in another instance merely by specifying the proper map coded font structured field.
• The presence of the map structured field in a MO:DCA environment group indicates use of the named resource within the scope of the environment group.

Position

public static final SFType Position

A position structured field specifies the coordinate offset value and orientation for presentation spaces.

Process

public static final SFType Process

A process structured field specifies processing to be performed on an object.

Orientation

public static final SFType Orientation

FOCA ???

Include

public static final SFType Include

An include structured field selects a named resource which is to be embedded in the including data stream as if it appeared inline. External resource object names on the begin structured field may or may not coincide with the library name of that object, as library name resolution is outside the scope of the MO:DCA architecture.

Reserved

public static final SFType Reserved

See MO:DCA-L: The OS/2 Presentation Manager Metafile (.met) Format.

Migration

public static final SFType Migration

A migration structured field is used to distinguish the MO:DCA structured field from a structured field with the same acronym from an earlier data-stream architecture. The earlier version is called Format 1. The MO:DCA version is called Format 2.

Variable

public static final SFType Variable

A variable structured field defines or contains variable information.

Link

public static final SFType Link

A link structured field defines a logical connection, or linkage, between two document components.

Data

public static final SFType Data

A data structured field consists of data whose meaning and interpretation is governed by the object architecture for the particular data object type.

Method Detail

values

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

Returns:

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

valueOf

public static SFType 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 SFType valueOf(int sfTypeByte)

toByte

public int toByte()