APIdia Launch Partner
Top Description Fields Constructors Methods
com.badlogic.gdx.tools.hiero

public Class HieroSettings

extends Object
Class Inheritance
Imports
java.io.BufferedReader, .File, .IOException, .InputStreamReader, .PrintStream, java.util.ArrayList, .Iterator, .List, com.badlogic.gdx.Gdx, com.badlogic.gdx.tools.hiero.unicodefont.UnicodeFont, .UnicodeFont.RenderType, com.badlogic.gdx.tools.hiero.unicodefont.effects.ConfigurableEffect, .ConfigurableEffect.Value, com.badlogic.gdx.utils.GdxRuntimeException

Holds the settings needed to configure a UnicodeFont.
Author
Nathan Sweet

Field Summary

Modifier and TypeField and Description
private boolean
private final List<E>
private boolean
private String
private String
private int
private float
private int
private int
private String
private boolean
private boolean
private boolean
private int
private int
private int
private int
private int
private int
private static final String
private int

Constructor Summary

AccessConstructor and Description
public
public
HieroSettings(String
The file system or classpath location of the Hiero settings file.
hieroFileRef
)

Method Summary

Modifier and TypeMethod and Description
public List<E>
public String
public String
public int
public float
public int
public int
public String
public boolean
public int
public int
public int
public int
public int
public int
public int
public boolean
public boolean
public boolean
public boolean
public void
save(File file)

Saves the settings to a file.

public void
setBold(boolean bold)

public void
setFont2Active(boolean active)

public void
setFont2File(String filename)

public void
setFontName(String fontName)

public void
setFontSize(int fontSize)

public void
setGamma(float gamma)

public void
setGlyphPageHeight(int glyphPageHeight)

public void
setGlyphPageWidth(int glyphPageWidth)

public void
public void
setItalic(boolean italic)

public void
setMono(boolean mono)

public void
setNativeRendering(boolean nativeRendering)

public void
setPaddingAdvanceX(int paddingAdvanceX)

public void
setPaddingAdvanceY(int paddingAdvanceY)

public void
setPaddingBottom(int paddingBottom)

public void
setPaddingLeft(int paddingLeft)

public void
setPaddingRight(int paddingRight)

public void
setPaddingTop(int paddingTop)

public void
setRenderType(int renderType)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

boldback to summary
private boolean bold
effectsback to summary
private final List<E> effects
font2Activeback to summary
private boolean font2Active
font2Fileback to summary
private String font2File
fontNameback to summary
private String fontName
fontSizeback to summary
private int fontSize
gammaback to summary
private float gamma
glyphPageHeightback to summary
private int glyphPageHeight
glyphPageWidthback to summary
private int glyphPageWidth
glyphTextback to summary
private String glyphText
italicback to summary
private boolean italic
monoback to summary
private boolean mono
nativeRenderingback to summary
private boolean nativeRendering
paddingAdvanceXback to summary
private int paddingAdvanceX
paddingAdvanceYback to summary
private int paddingAdvanceY
paddingBottomback to summary
private int paddingBottom
paddingLeftback to summary
private int paddingLeft
paddingRightback to summary
private int paddingRight
paddingTopback to summary
private int paddingTop
RENDER_TYPEback to summary
private static final String RENDER_TYPE
renderTypeback to summary
private int renderType

Constructor Detail

HieroSettingsback to summary
public HieroSettings()
HieroSettingsback to summary
public HieroSettings(String hieroFileRef)
Parameters
hieroFileRef:String

The file system or classpath location of the Hiero settings file.

Method Detail

getEffectsback to summary
public List<E> getEffects()
See Also
UnicodeFont#getEffects()
getFont2Fileback to summary
public String getFont2File()
getFontNameback to summary
public String getFontName()
See Also
UnicodeFont#UnicodeFont(String, int, boolean, boolean), UnicodeFont#UnicodeFont(java.awt.Font, int, boolean, boolean)
getFontSizeback to summary
public int getFontSize()
See Also
UnicodeFont#UnicodeFont(String, int, boolean, boolean), UnicodeFont#UnicodeFont(java.awt.Font, int, boolean, boolean)
getGammaback to summary
public float getGamma()
getGlyphPageHeightback to summary
public int getGlyphPageHeight()
See Also
UnicodeFont#getGlyphPageHeight()
getGlyphPageWidthback to summary
public int getGlyphPageWidth()
See Also
UnicodeFont#getGlyphPageWidth()
getGlyphTextback to summary
public String getGlyphText()
getNativeRenderingback to summary
public boolean getNativeRendering()
getPaddingAdvanceXback to summary
public int getPaddingAdvanceX()
See Also
UnicodeFont#getPaddingAdvanceX()
getPaddingAdvanceYback to summary
public int getPaddingAdvanceY()
See Also
UnicodeFont#getPaddingAdvanceY()
getPaddingBottomback to summary
public int getPaddingBottom()
See Also
UnicodeFont#getPaddingBottom()
getPaddingLeftback to summary
public int getPaddingLeft()
See Also
UnicodeFont#getPaddingLeft()
getPaddingRightback to summary
public int getPaddingRight()
See Also
UnicodeFont#getPaddingRight()
getPaddingTopback to summary
public int getPaddingTop()
See Also
UnicodeFont#getPaddingTop()
getRenderTypeback to summary
public int getRenderType()
isBoldback to summary
public boolean isBold()
See Also
UnicodeFont#UnicodeFont(String, int, boolean, boolean), UnicodeFont#UnicodeFont(java.awt.Font, int, boolean, boolean)
isFont2Activeback to summary
public boolean isFont2Active()
isItalicback to summary
public boolean isItalic()
See Also
UnicodeFont#UnicodeFont(String, int, boolean, boolean), UnicodeFont#UnicodeFont(java.awt.Font, int, boolean, boolean)
isMonoback to summary
public boolean isMono()
saveback to summary
public void save(File file) throws IOException

Saves the settings to a file.

Exceptions
IOException:
if the file could not be saved.
setBoldback to summary
public void setBold(boolean bold)
See Also
UnicodeFont#UnicodeFont(String, int, boolean, boolean), UnicodeFont#UnicodeFont(java.awt.Font, int, boolean, boolean)
setFont2Activeback to summary
public void setFont2Active(boolean active)
setFont2Fileback to summary
public void setFont2File(String filename)
setFontNameback to summary
public void setFontName(String fontName)
See Also
UnicodeFont#UnicodeFont(String, int, boolean, boolean), UnicodeFont#UnicodeFont(java.awt.Font, int, boolean, boolean)
setFontSizeback to summary
public void setFontSize(int fontSize)
See Also
UnicodeFont#UnicodeFont(String, int, boolean, boolean), UnicodeFont#UnicodeFont(java.awt.Font, int, boolean, boolean)
setGammaback to summary
public void setGamma(float gamma)
setGlyphPageHeightback to summary
public void setGlyphPageHeight(int glyphPageHeight)
See Also
UnicodeFont#setGlyphPageHeight(int)
setGlyphPageWidthback to summary
public void setGlyphPageWidth(int glyphPageWidth)
See Also
UnicodeFont#setGlyphPageWidth(int)
setGlyphTextback to summary
public void setGlyphText(String text)
setItalicback to summary
public void setItalic(boolean italic)
See Also
UnicodeFont#UnicodeFont(String, int, boolean, boolean), UnicodeFont#UnicodeFont(java.awt.Font, int, boolean, boolean)
setMonoback to summary
public void setMono(boolean mono)
setNativeRenderingback to summary
public void setNativeRendering(boolean nativeRendering)
setPaddingAdvanceXback to summary
public void setPaddingAdvanceX(int paddingAdvanceX)
See Also
UnicodeFont#setPaddingAdvanceX(int)
setPaddingAdvanceYback to summary
public void setPaddingAdvanceY(int paddingAdvanceY)
See Also
UnicodeFont#setPaddingAdvanceY(int)
setPaddingBottomback to summary
public void setPaddingBottom(int paddingBottom)
See Also
UnicodeFont#setPaddingBottom(int)
setPaddingLeftback to summary
public void setPaddingLeft(int paddingLeft)
See Also
UnicodeFont#setPaddingLeft(int)
setPaddingRightback to summary
public void setPaddingRight(int paddingRight)
See Also
UnicodeFont#setPaddingRight(int)
setPaddingTopback to summary
public void setPaddingTop(int paddingTop)
See Also
UnicodeFont#setPaddingTop(int)
setRenderTypeback to summary
public void setRenderType(int renderType)