org.apache.poi.hwmf.record
Class HwmfFont

java.lang.Object
  extended by org.apache.poi.hwmf.record.HwmfFont
All Implemented Interfaces:
FontInfo

public class HwmfFont
extends java.lang.Object
implements FontInfo

The Font object specifies the attributes of a logical font


Nested Class Summary
static class HwmfFont.WmfClipPrecision
          ClipPrecision Flags specify clipping precision, which defines how to clip characters that are partially outside a clipping region.
static class HwmfFont.WmfFontQuality
          The output quality defines how carefully to attempt to match the logical font attributes to those of an actual physical font.
static class HwmfFont.WmfOutPrecision
          The output precision defines how closely the output must match the requested font's height, width, character orientation, escapement, pitch, and font type.
 
Constructor Summary
HwmfFont()
           
 
Method Summary
 FontCharset getCharset()
           
 HwmfFont.WmfClipPrecision getClipPrecision()
           
 int getEscapement()
           
 FontFamily getFamily()
           
 int getHeight()
           
 java.lang.Integer getIndex()
          Get the index within the collection of Font objects
 int getOrientation()
           
 HwmfFont.WmfOutPrecision getOutPrecision()
           
 FontPitch getPitch()
           
 int getPitchAndFamily()
           
 HwmfFont.WmfFontQuality getQuality()
           
 java.lang.String getTypeface()
           
 int getWeight()
           
 int getWidth()
           
 int init(LittleEndianInputStream leis)
           
 boolean isItalic()
           
 boolean isStrikeOut()
           
 boolean isUnderline()
           
 void setCharset(FontCharset charset)
          Sets the charset
 void setFamily(FontFamily family)
          Sets the font family class
 void setIndex(int index)
          Sets the index within the collection of Font objects
 void setPitch(FontPitch pitch)
          Set the font pitch
 void setTypeface(java.lang.String typeface)
          Sets the font name
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HwmfFont

public HwmfFont()
Method Detail

init

public int init(LittleEndianInputStream leis)
         throws java.io.IOException
Throws:
java.io.IOException

getHeight

public int getHeight()

getWidth

public int getWidth()

getEscapement

public int getEscapement()

getOrientation

public int getOrientation()

getWeight

public int getWeight()

isItalic

public boolean isItalic()

isUnderline

public boolean isUnderline()

isStrikeOut

public boolean isStrikeOut()

getOutPrecision

public HwmfFont.WmfOutPrecision getOutPrecision()

getClipPrecision

public HwmfFont.WmfClipPrecision getClipPrecision()

getQuality

public HwmfFont.WmfFontQuality getQuality()

getPitchAndFamily

public int getPitchAndFamily()

getFamily

public FontFamily getFamily()
Specified by:
getFamily in interface FontInfo
Returns:
the family class

setFamily

public void setFamily(FontFamily family)
Description copied from interface: FontInfo
Sets the font family class

Specified by:
setFamily in interface FontInfo
Parameters:
family - the font family class

getPitch

public FontPitch getPitch()
Specified by:
getPitch in interface FontInfo
Returns:
the font pitch or null if unsupported

setPitch

public void setPitch(FontPitch pitch)
Description copied from interface: FontInfo
Set the font pitch

Specified by:
setPitch in interface FontInfo
Parameters:
pitch - the font pitch

getIndex

public java.lang.Integer getIndex()
Description copied from interface: FontInfo
Get the index within the collection of Font objects

Specified by:
getIndex in interface FontInfo
Returns:
unique index number of the underlying record this Font represents (probably you don't care unless you're comparing which one is which)

setIndex

public void setIndex(int index)
Description copied from interface: FontInfo
Sets the index within the collection of Font objects

Specified by:
setIndex in interface FontInfo
Parameters:
index - the index within the collection of Font objects

getTypeface

public java.lang.String getTypeface()
Specified by:
getTypeface in interface FontInfo
Returns:
the full name of the font, i.e. font family + type face

setTypeface

public void setTypeface(java.lang.String typeface)
Description copied from interface: FontInfo
Sets the font name

Specified by:
setTypeface in interface FontInfo
Parameters:
typeface - the full name of the font, when null removes the font definition - removal is implementation specific

getCharset

public FontCharset getCharset()
Specified by:
getCharset in interface FontInfo
Returns:
the font charset

setCharset

public void setCharset(FontCharset charset)
Description copied from interface: FontInfo
Sets the charset

Specified by:
setCharset in interface FontInfo
Parameters:
charset - the charset


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