Panose.Field (docx4j-core 8.3.4 API)

java.lang.Object
- java.lang.Enum<Panose.Field>
- - org.docx4j.fonts.foray.font.format.Panose.Field

All Implemented Interfaces:

Serializable, Comparable<Panose.Field>

Enclosing class:

Panose
```
public static enum Panose.Field
extends Enum<Panose.Field>
```
Enumeration of the fields that comprise a PANOSE description.

See Also:

"http://fonts.apple.com/TTRefMan/RM06/Chap6OS2.html"

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ARM_STYLE` The bArmStyle field.
`CONTRAST` The bContrast field.
`FAMILY_TYPE` The bFamilyType field.
`LETTERFORM` The bLetterform field.
`MIDLINE` The bMidline field.
`PROPORTION` The bProportion field.
`SERIF_STYLE` The bSerifStyle field.
`STROKE_VARIATION` The bStrokeVariatoon field.
`WEIGHT` The bWeight field.
`X_HEIGHT` The bXHeight field.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte`	`getIndex()` Returns the 0-based index of this element in the PANOSE array.
`byte`	`getMaxValue()` Returns the maximum valid value for this field.
`static Panose.Field`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Panose.Field[]`	`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
  - FAMILY_TYPE
```
public static final Panose.Field FAMILY_TYPE
```
    The bFamilyType field.
  - SERIF_STYLE
```
public static final Panose.Field SERIF_STYLE
```
    The bSerifStyle field.
  - WEIGHT
```
public static final Panose.Field WEIGHT
```
    The bWeight field.
  - PROPORTION
```
public static final Panose.Field PROPORTION
```
    The bProportion field.
  - CONTRAST
```
public static final Panose.Field CONTRAST
```
    The bContrast field.
  - STROKE_VARIATION
```
public static final Panose.Field STROKE_VARIATION
```
    The bStrokeVariatoon field.
  - ARM_STYLE
```
public static final Panose.Field ARM_STYLE
```
    The bArmStyle field.
  - LETTERFORM
```
public static final Panose.Field LETTERFORM
```
    The bLetterform field.
  - MIDLINE
```
public static final Panose.Field MIDLINE
```
    The bMidline field.
  - X_HEIGHT
```
public static final Panose.Field X_HEIGHT
```
    The bXHeight field.
- Method Detail
  - values
```
public static Panose.Field[] 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 (Panose.Field c : Panose.Field.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Panose.Field 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
  - getIndex
```
public byte getIndex()
```
    Returns the 0-based index of this element in the PANOSE array.
    
    Returns:
    
    The 0-based index of this element in the PANOSE array.
  - getMaxValue
```
public byte getMaxValue()
```
    Returns the maximum valid value for this field.
    
    Returns:
    
    The maximum valid value for this field.

Enum Panose.Field

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

FAMILY_TYPE

SERIF_STYLE

WEIGHT

PROPORTION

CONTRAST

STROKE_VARIATION

ARM_STYLE

LETTERFORM

MIDLINE

X_HEIGHT

Method Detail

values

valueOf

getIndex

getMaxValue