HersheyFont (OpenIMAJ master project 1.3.1 API)

java.lang.Object
- java.lang.Enum<HersheyFont>
- - org.openimaj.image.typography.hershey.HersheyFont

All Implemented Interfaces:

Serializable, Comparable<HersheyFont>, Font<HersheyFont>
```
public enum HersheyFont
extends Enum<HersheyFont>
implements Font<HersheyFont>
```
The set of Hershey's vector fonts.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ASTROLOGY` Hershey Astrology
`CURSIVE` Hershey Cursive
`CYRILLIC` Hershey Cyrillic
`CYRILLIC_1` Hershey Cyrillic 1
`FUTURA_LIGHT` Hershey Futura Light
`FUTURA_MEDIUM` Hershey Futura Medium
`GOTHIC_ENGLISH` Hershey Gothic English
`GOTHIC_ENGLISH_TRIPLEX` Hershey Gothic English Triplex
`GOTHIC_GERMAN` Hershey Gothic German
`GOTHIC_GERMAN_TRIPLEX` Hershey Gothic German Triplex
`GOTHIC_ITALIAN` Hershey Gothic Italian
`GOTHIC_ITALIAN_TRIPLEX` Hershey Gothic Italian Triplex
`GREEK` Hershey Greek
`GREEK_COMPLEX` Hershey Greek Complex
`GREEK_SIMPLEX` Hershey Greek Simplex
`JAPANESE` Hershey Japanese
`MARKERS` Hershey Markers
`MATH_LOWER` Hershey Math Lower
`MATH_UPPER` Hershey Math Upper
`METEOROLOGY` Hershey Meteorology
`MUSIC` Hershey Music
`ROMAN_DUPLEX` Hershey Roman Duplex
`ROMAN_SIMPLEX` Hershey Roman Simplex
`ROMAN_TRIPLEX` Hershey Roman Triplex
`SCRIPT_COMPLEX` Hershey Script Complex
`SCRIPT_SIMPLEX` Hershey Script Simplex
`SYMBOLIC` Hershey Symbolic
`TIMES_BOLD` Hershey Times Bold
`TIMES_BOLD_ITALIC` Hershey Times Bold Italic
`TIMES_GREEK` Hershey Greek
`TIMES_MEDIUM` Hershey Times Medium
`TIMES_MEDIUM_ITALIC` Hershey Times Medium Italic

Field Summary

Fields
Modifier and Type Field and Description

protected org.openimaj.image.typography.hershey.HersheyFontData data

protected String name

Fields
Modifier and Type	Field and Description
`protected org.openimaj.image.typography.hershey.HersheyFontData`	`data`
`protected String`	`name`

Method Summary

Methods
Modifier and Type	Method and Description
`<T> HersheyFontStyle<T>`	`createStyle(ImageRenderer<T,?> renderer)` Create an instance of a FontStyle with the default parameters for the given image.
`String`	`getName()` Get the name of this font
`<T,Q extends FontStyle<T>> FontRenderer<T,Q>`	`getRenderer(ImageRenderer<T,?> renderer)` Get a font renderer suitable for rendering this font to the given image renderer.
`static void`	`main(String[] args)` Demonstrate the font engine
`static HersheyFont`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static HersheyFont[]`	`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
  - ASTROLOGY
```
public static final HersheyFont ASTROLOGY
```
    Hershey Astrology
  - CURSIVE
```
public static final HersheyFont CURSIVE
```
    Hershey Cursive
  - CYRILLIC_1
```
public static final HersheyFont CYRILLIC_1
```
    Hershey Cyrillic 1
  - CYRILLIC
```
public static final HersheyFont CYRILLIC
```
    Hershey Cyrillic
  - FUTURA_LIGHT
```
public static final HersheyFont FUTURA_LIGHT
```
    Hershey Futura Light
  - FUTURA_MEDIUM
```
public static final HersheyFont FUTURA_MEDIUM
```
    Hershey Futura Medium
  - GOTHIC_ENGLISH_TRIPLEX
```
public static final HersheyFont GOTHIC_ENGLISH_TRIPLEX
```
    Hershey Gothic English Triplex
  - GOTHIC_GERMAN_TRIPLEX
```
public static final HersheyFont GOTHIC_GERMAN_TRIPLEX
```
    Hershey Gothic German Triplex
  - GOTHIC_ENGLISH
```
public static final HersheyFont GOTHIC_ENGLISH
```
    Hershey Gothic English
  - GOTHIC_GERMAN
```
public static final HersheyFont GOTHIC_GERMAN
```
    Hershey Gothic German
  - GOTHIC_ITALIAN
```
public static final HersheyFont GOTHIC_ITALIAN
```
    Hershey Gothic Italian
  - GOTHIC_ITALIAN_TRIPLEX
```
public static final HersheyFont GOTHIC_ITALIAN_TRIPLEX
```
    Hershey Gothic Italian Triplex
  - GREEK
```
public static final HersheyFont GREEK
```
    Hershey Greek
  - GREEK_COMPLEX
```
public static final HersheyFont GREEK_COMPLEX
```
    Hershey Greek Complex
  - GREEK_SIMPLEX
```
public static final HersheyFont GREEK_SIMPLEX
```
    Hershey Greek Simplex
  - JAPANESE
```
public static final HersheyFont JAPANESE
```
    Hershey Japanese
  - MARKERS
```
public static final HersheyFont MARKERS
```
    Hershey Markers
  - MATH_LOWER
```
public static final HersheyFont MATH_LOWER
```
    Hershey Math Lower
  - MATH_UPPER
```
public static final HersheyFont MATH_UPPER
```
    Hershey Math Upper
  - METEOROLOGY
```
public static final HersheyFont METEOROLOGY
```
    Hershey Meteorology
  - MUSIC
```
public static final HersheyFont MUSIC
```
    Hershey Music
  - ROMAN_DUPLEX
```
public static final HersheyFont ROMAN_DUPLEX
```
    Hershey Roman Duplex
  - ROMAN_SIMPLEX
```
public static final HersheyFont ROMAN_SIMPLEX
```
    Hershey Roman Simplex
  - ROMAN_TRIPLEX
```
public static final HersheyFont ROMAN_TRIPLEX
```
    Hershey Roman Triplex
  - SCRIPT_COMPLEX
```
public static final HersheyFont SCRIPT_COMPLEX
```
    Hershey Script Complex
  - SCRIPT_SIMPLEX
```
public static final HersheyFont SCRIPT_SIMPLEX
```
    Hershey Script Simplex
  - SYMBOLIC
```
public static final HersheyFont SYMBOLIC
```
    Hershey Symbolic
  - TIMES_GREEK
```
public static final HersheyFont TIMES_GREEK
```
    Hershey Greek
  - TIMES_MEDIUM_ITALIC
```
public static final HersheyFont TIMES_MEDIUM_ITALIC
```
    Hershey Times Medium Italic
  - TIMES_BOLD_ITALIC
```
public static final HersheyFont TIMES_BOLD_ITALIC
```
    Hershey Times Bold Italic
  - TIMES_MEDIUM
```
public static final HersheyFont TIMES_MEDIUM
```
    Hershey Times Medium
  - TIMES_BOLD
```
public static final HersheyFont TIMES_BOLD
```
    Hershey Times Bold
- Field Detail
  - data
```
protected org.openimaj.image.typography.hershey.HersheyFontData data
```
  - name
```
protected String name
```
- Method Detail
  - values
```
public static HersheyFont[] 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 (HersheyFont c : HersheyFont.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static HersheyFont 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
  - getRenderer
```
public <T,Q extends FontStyle<T>> FontRenderer<T,Q> getRenderer(ImageRenderer<T,?> renderer)
```
    Description copied from interface: Font
    
    Get a font renderer suitable for rendering this font to the given image renderer.
    
    Specified by:
    
    getRenderer in interface Font<HersheyFont>
    
    Type Parameters:
    T - type of pixel.
    Q - type of FontStyle.
    Parameters:
    renderer - the target image renderer.
    
    Returns:
    the FontRenderer
  - createStyle
```
public <T> HersheyFontStyle<T> createStyle(ImageRenderer<T,?> renderer)
```
    Description copied from interface: Font
    
    Create an instance of a FontStyle with the default parameters for the given image.
    
    Specified by:
    
    createStyle in interface Font<HersheyFont>
    
    Type Parameters:
    T - type of pixel.
    Parameters:
    renderer - the image renderer
    
    Returns:
    the FontStyle
  - getName
```
public String getName()
```
    Description copied from interface: Font
    
    Get the name of this font
    
    Specified by:
    
    getName in interface Font<HersheyFont>
    
    Returns:
    the name of the font
  - main
```
public static void main(String[] args)
```
    Demonstrate the font engine
    
    Parameters:
    args - not used

Enum HersheyFont

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ASTROLOGY

CURSIVE

CYRILLIC_1

CYRILLIC

FUTURA_LIGHT

FUTURA_MEDIUM

GOTHIC_ENGLISH_TRIPLEX

GOTHIC_GERMAN_TRIPLEX

GOTHIC_ENGLISH

GOTHIC_GERMAN

GOTHIC_ITALIAN

GOTHIC_ITALIAN_TRIPLEX

GREEK

GREEK_COMPLEX

GREEK_SIMPLEX

JAPANESE

MARKERS

MATH_LOWER

MATH_UPPER

METEOROLOGY

MUSIC

ROMAN_DUPLEX

ROMAN_SIMPLEX

ROMAN_TRIPLEX

SCRIPT_COMPLEX

SCRIPT_SIMPLEX

SYMBOLIC

TIMES_GREEK

TIMES_MEDIUM_ITALIC

TIMES_BOLD_ITALIC

TIMES_MEDIUM

TIMES_BOLD

Field Detail

data

name

Method Detail

values

valueOf

getRenderer

createStyle

getName

main