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

## org.apache.poi.hslf.record
Class FontCollection

    java.lang.Object
      org.apache.poi.hslf.record.Record
          org.apache.poi.hslf.record.RecordContainer
              org.apache.poi.hslf.record.FontCollection

    public final class FontCollection

extends RecordContainer

`FontCollection` ia a container that holds information about all the fonts in the presentation.

Field Summary

Fields inherited from class org.apache.poi.hslf.record.RecordContainer
`_children`

Fields inherited from class org.apache.poi.hslf.record.Record
`logger`

Constructor Summary
`protected` | `FontCollection(byte[] source, int start, int len)`

Method Summary
`HSLFFontInfo` | `addFont(FontInfo fontInfo)` Add font with the given FontInfo configuration to the font collection.
`HSLFFontInfo` | `getFontInfo(int index)` Lookup a FontInfo object by its internal font index
`HSLFFontInfo` | `getFontInfo(java.lang.String typeface)` Lookup a FontInfo object by its typeface
`int` | `getNumberOfFonts()`
`long` | `getRecordType()` Return the type, which is 2005
`void` | `writeOut(java.io.OutputStream out)` Write the contents of the record back, so it can be written to disk

Methods inherited from class org.apache.poi.hslf.record.RecordContainer
`addChildAfter, addChildBefore, appendChildRecord, findFirstOfType, getChildRecords, handleParentAwareRecords, isAnAtom, moveChildBefore, moveChildrenAfter, moveChildrenBefore, removeChild, setChildRecord, writeOut`

Methods inherited from class org.apache.poi.hslf.record.Record
`buildRecordAtOffset, createRecordForType, findChildRecords, writeLittleEndian, writeLittleEndian`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### FontCollection

    protected FontCollection(byte[] source,
                             int start,
                             int len)

Method Detail

### getRecordType

    public long getRecordType()

  Return the type, which is 2005

  Specified by:
    `getRecordType` in class `Record`

### writeOut

    public void writeOut(java.io.OutputStream out)
                  throws java.io.IOException

  Write the contents of the record back, so it can be written to disk

  Specified by:
    `writeOut` in class `Record`
  Throws:
    `java.io.IOException`

### addFont

    public HSLFFontInfo addFont(FontInfo fontInfo)

  Add font with the given FontInfo configuration to the font collection. The returned FontInfo contains the HSLF specific details and the collection uniquely contains fonts based on their typeface, i.e. calling the method with FontInfo objects having the same name results in the same HSLFFontInfo reference.

  Parameters:
    `fontInfo` - the FontInfo configuration, can be a instance of `HSLFFontInfo`, `HSLFFontInfoPredefined` or a custom implementation
  Returns:
    the register HSLFFontInfo object

### getFontInfo

    public HSLFFontInfo getFontInfo(java.lang.String typeface)

  Lookup a FontInfo object by its typeface

  Parameters:
    `typeface` - the full font name
  Returns:
    the HSLFFontInfo for the given name or `null` if not found

### getFontInfo

    public HSLFFontInfo getFontInfo(int index)

  Lookup a FontInfo object by its internal font index

  Parameters:
    `index` - the internal font index
  Returns:
    the HSLFFontInfo for the given index or `null` if not found

### getNumberOfFonts

    public int getNumberOfFonts()

  Returns:
    the number of registered fonts

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

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