Class TextStyle.Builder

java.lang.Object
com.luciad.text.TextStyle.Builder
All Implemented Interfaces:
AutoCloseable
Enclosing class:
TextStyle

public static final class TextStyle.Builder extends Object implements AutoCloseable
A builder class for creating text styles.
  • Constructor Details Link icon

  • Method Details Link icon

    • finalize Link icon

      protected void finalize()
      Overrides:
      finalize in class Object
    • close Link icon

      public void close()
      Specified by:
      close in interface AutoCloseable
    • build Link icon

      @NotNull public TextStyle build()
      Creates a newly created text style, based on the properties set on this builder.
      Returns:
      a newly created text style, based on the properties set on this builder.
    • fontName Link icon

      @NotNull public TextStyle.Builder fontName(@NotNull String fontName)
      Sets the font name used for text rendering (possible values: Serif, Sans, Arial, Arial Black, Arial Narrow, Calibri, Console, Noto).

      If not specified, then the Serif font will be used to display text. The Noto font has support for the following alphabets: Arabic, Armenian, Bengali, Cyrillic, Devanagari, Georgian, Greek, Gujarati, Gurmukhi, Hangul, Han, Hebrew, Hiragana, Kanji, Kannada, Katakana, Lao, Latin, Malayalam, Oriya, Tamil, Telugu and Thai. Other fonts only support Latin alphabets.

      Parameters:
      fontName - identifier of the font used for text rendering.
      Returns:
      this builder
    • fontSize Link icon

      @NotNull public TextStyle.Builder fontSize(long fontSize)
      Sets the font size in pixels , where a pixel is defined as 1/96th of 1 inch (https://www.w3.org/TR/css-values-4/#absolute-lengths).

      The font size value must be > 0. If not specified, a size of 14 is used.

      Parameters:
      fontSize - the font size in pixels, where a pixel is defined as 1/96th of 1 inch.
      Returns:
      this builder
    • textColor Link icon

      @NotNull public TextStyle.Builder textColor(@NotNull android.graphics.Color textColor)
      Sets the text color.

      By default, this is black.

      Parameters:
      textColor - The text color.
      Returns:
      this builder.
    • haloWidth Link icon

      @NotNull public TextStyle.Builder haloWidth(double haloWidth)
      Sets the width of the halo (outline) around the text in pixels.

      This value must be greater then or equal to zero. If this value is equal to zero, no halo is drawn. Text halo width is 1 pixel wide by default.

      Parameters:
      haloWidth - the size of the halo (outline) around text in pixels.
      Returns:
      this builder
    • haloColor Link icon

      @NotNull public TextStyle.Builder haloColor(@NotNull android.graphics.Color haloColor)
      Sets the color of the halo (outline) around the text.

      The default value is white.

      Parameters:
      haloColor - the color of the halo (outline) around the text.
      Returns:
      this builder