Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD

## org.apache.poi.common.usermodel.fonts
Enum FontPitch

    java.lang.Object
      java.lang.Enum<FontPitch>
          org.apache.poi.common.usermodel.fonts.FontPitch

All Implemented Interfaces:
  java.io.Serializable, java.lang.Comparable<FontPitch>

    public enum FontPitch

extends java.lang.Enum<FontPitch>

A property of a font that describes the pitch, of the characters.

Since:
  POI 3.17-beta2

Enum Constant Summary
`DEFAULT` The default pitch, which is implementation-dependent.
`FIXED` A fixed pitch, which means that all the characters in the font occupy the same width when output in a string.
`VARIABLE` A variable pitch, which means that the characters in the font occupy widths that are proportional to the actual widths of the glyphs when output in a string.

Method Summary
`int` | `getNativeId()`
`static byte` | `getNativeId(FontPitch pitch, FontFamily family)` Combine pitch and family to native id
`static FontPitch` | `valueOf(int flag)`
`static FontPitch` | `valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static FontPitch` | `valueOfPitchFamily(byte pitchAndFamily)` Get FontPitch from native id
`static FontPitch[]` | `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

### DEFAULT

    public static final FontPitch DEFAULT

  The default pitch, which is implementation-dependent.

### FIXED

    public static final FontPitch FIXED

  A fixed pitch, which means that all the characters in the font occupy the same width when output in a string.

### VARIABLE

    public static final FontPitch VARIABLE

  A variable pitch, which means that the characters in the font occupy widths that are proportional to the actual widths of the glyphs when output in a string. For example, the "i" and space characters usually have much smaller widths than a "W" or "O" character.

Method Detail

### values

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

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

### valueOf

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

### getNativeId

    public int getNativeId()

### valueOf

    public static FontPitch valueOf(int flag)

### getNativeId

    public static byte getNativeId(FontPitch pitch,
                                   FontFamily family)

  Combine pitch and family to native id

  See Also:
    LOGFONT structure

### valueOfPitchFamily

    public static FontPitch valueOfPitchFamily(byte pitchAndFamily)

  Get FontPitch from native id

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD

Copyright 2017 The Apache Software Foundation or its licensors, as applicable.