Package pi.actor

Class ImageText.Font

java.lang.Object
pi.actor.ImageText.Font
Enclosing class:
ImageText
public static class ImageText.Font extends Object
Eine Schriftart, bei der die einzelnen Buchstaben durch ein Bild repräsentiert sind.

Jedes Bild entspricht einem Buchstaben oder Zeichen. Die Bilder müssen alle die gleiche Abmessung aufweisen.

Eine Alternative wäre die BitmapFont-Klasse der Game-Engine libgdx. ...

Since:
0.23.0
Author:
Josef Friedrich
See Also:

  • Constructor Details

    • Font

      public Font(@NonNull String basePath, @NonNull String extension)
      Erzeugt eine neue Bilderschriftart.
      Parameters:
      basePath - Der Pfad zu einem Ordner, in dem die Bilder der einzelnen Buchstaben liegen.
      extension - Die Dateierweiterung der Buchstabenbilder.

    • Font

      public Font(@NonNull String basePath)
      Erzeugt eine neue Bilderschriftart. Die einzelnen Glyphen müssen als Dateierweiterung png haben. Der Text wird linksbündig ausgerichtet.
      Parameters:
      basePath - Der Pfad zu einem Ordner, in dem die Bilder der einzelnen Buchstaben liegen.

  • Method Details

    • basePath

      @API @Getter public String basePath()
      Gibt dem Pfad zu einem Ordner, in dem die Bilder der einzelnen Buchstaben liegen, zurück.
      Returns:
      Der Pfad zu einem Ordner, in dem die Bilder der einzelnen Buchstaben liegen.
      Since:
      0.46.0

    • basePath

      @API @Setter @ChainableMethod public ImageText.Font basePath(@NonNull String basePath)
      Setzt den Pfad zu einem Ordner, in dem die Bilder der einzelnen Buchstaben liegen.
      Parameters:
      basePath - Der Pfad zu einem Ordner, in dem die Bilder der einzelnen Buchstaben liegen.
      Returns:
      Eine Instanz dieser Klasse, damit mehrere Setter mit der Punktschreibweise verkettet werden können.

    • glyphWidth

      @API @Getter public int glyphWidth()
      Gibt die Breite der Buchstabenbilder in Pixel zurück.
      Returns:
      Die Breite der Buchstabenbilder in Pixel.

    • glyphHeight

      @API @Getter public int glyphHeight()
      Gibt die Höhe der Buchstabenbilder in Pixel zurück.
      Returns:
      Die Höhe der Buchstabenbilder in Pixel.
      Since:
      0.46.0

    • extension

      @API @Getter public @NonNull String extension()
      Gibt die Dateierweiterung der Buchstabenbilder zurück.
      Returns:
      Die Dateierweiterung der Buchstabenbilder.
      Since:
      0.46.0

    • extension

      @API @Setter @ChainableMethod public ImageText.Font extension(@NonNull String extension)
      Setzt die Dateierweiterung der Buchstabenbilder.
      Parameters:
      extension - Die Dateierweiterung der Buchstabenbilder.
      Returns:
      Eine Instanz dieser Klasse, damit mehrere Setter mit der Punktschreibweise verkettet werden können.

    • supportsCase

      @API @Getter public @Nullable ImageText.CaseSensitivity supportsCase()
      Gibt die Handhabung der Groß- und Kleinschreibung zurück.

      Diese Methode liefert zurück, ob die Bilderschriftart nur Großschreibung oder nur Kleinschreibung unterstützt. Ist das Attribut auf null gesetzt, so unterstützt die Schriftart sowohl Klein- als auch Großschreibung.

      Returns:
      Die Handhabung der Groß- und Kleinschreibung.
      Since:
      0.46.0

    • supportsCase

      @API @Setter @ChainableMethod public ImageText.Font supportsCase(@Nullable ImageText.CaseSensitivity supportsCase)
      Setzt die Handhabung der Groß- und Kleinschreibung.

      Diese Methode legt fest, ob die Bilderschriftart nur Großschreibung oder nur Kleinschreibung unterstützt. Ist das Attribut auf null gesetzt, so unterstützt die Schriftart sowohl Klein- als auch Großschreibung.

      Parameters:
      supportsCase - Die Handhabung der Groß- und Kleinschreibung.
      Since:
      0.46.0

    • throwException

      @API @Setter @ChainableMethod public ImageText.Font throwException(boolean throwException)
      Setzt, ob bei einem nicht vorhandenen Zeichen eine Fehlermeldung geworfen werden soll oder nicht.
      Parameters:
      throwException - Ob bei einem nicht vorhandenen Zeichen eine Fehlermeldung geworfen werden soll oder nicht.
      Returns:
      Eine Instanz dieser Klasse, damit mehrere Setter mit der Punktschreibweise verkettet werden können.

    • glyphs

      @API @Getter public ImageText.Glyph[] glyphs()
      Gibt die Zeichen der Bilderschriftart als Feld/Array zurück.
      Returns:
      Die Zeichen der Bilderschriftart als Feld/Array.

    • addMapping

      @API @ChainableMethod public ImageText.Font addMapping(char glyph, String filename)
      Ordnet einem Zeichen einem Bilder-Dateinamen zu.

      Nicht alle Zeichen wie zum Beispiel der Schrägstrich oder der Doppelpunkt können als Dateinamen verwendet werden.

      Parameters:
      glyph - Das Zeichen, das durch ein Bild dargestellt werden soll.
      filename - Der Dateiname des Bilds ohne Dateierweiterung, das ein Zeichen darstellt, relativ zu basePath.
      Returns:
      Eine Instanz dieser Klasse, damit mehrere Setter mit der Punktschreibweise verkettet werden können.