Class Font

Inteface for fonts.

Methods

• (int) get height
• (int) get ascent
• (int) get width of <string str> in pixels
• (int) get width of <string str> range <range strRange> in pixels
• (int) get size of <string str> fitting into <int width> pixels
• (int) get size of <string str> range <Range strRange> fitting into <int width> pixels

main
  Font f = system.get default font
  int height = f.get height
  int ascent = f.get ascent

  print "Default font properties. Height: " & height & " Ascent: " & ascent

  string testData = "Amount of pixels needed to show this text on one line is: "
  print testData & f.get width of testData in pixels

  int screenWidth = screen.get size.get width
  int amountOfData = f.get size of testData fitting into screenWidth pixels
  print amountOfData & " characters of test data can be shown on one line."
            

See Also

(int) get height

Returns the height of the font in pixels.

Return value

• Height of the font in pixels

main
  Font f = system.get default font
  print "System default font height: " & f.get height
                

(int) get ascent

Returns the distance from the top of the font to the base line.

Return value

• The ascent of the font

main
  Font f = system.get default font
  print "System default font ascent: " & f.get ascent
                

(int) get width of <string str> in pixels

Returns the width of a string in pixels when drawn, using this font.

Parameters

• str - The string to be measured.

Return value

• Width of the String in pixels.

main
  Font f = system.get default font
  int requiredWidth = f.get width of "Test data" in pixels

  print "Required screen width in pixels to display text on one line: " & requiredWidth
                

(int) get width of <string str> range <range strRange> in pixels

Returns the width of a string in pixels when drawn, using this font.

Parameters

• str - The string to be measured.
• strRange - An optional range that specifies the sub-string to measure.

Return value

• Width of the String in pixels.

Exceptions

• InvalidRangeException - If the range is outside the str's bounds.

main
  Font f = system.get default font
  int requiredWidth = f.get width of "Test data" range 0 size 2 in pixels

  print "Required screen width in pixels to display 2 first characters of text: " & requiredWidth
                

(int) get size of <string str> fitting into <int width> pixels

Returns the count of characters that are fully visible when String str is drawn using this font into a space that is width pixels wide.

Parameters

• str - The String that is being measured
• width - Width of the space where this string is drawn to

Return value

• Count of characters that fit into space that is width pixels wide

Exceptions

• InvalidRangeException - If the range is outside the str's bounds.

main
  Font f = system.get default font
  int charactersDisplayed = f.get size of "Test data" fitting into 100 pixels

  print "Amount of characters of text fitting into 100 pixels: " & charactersDisplayed
                

(int) get size of <string str> range <Range strRange> fitting into <int width> pixels

Returns the count of characters that are fully visible when part of String str is drawn using this font into space that is width pixels wide. The sub-range is defined by the Range strRange.

Parameters

• str - The String that is being measured
• strRange - Defines the sub-range of the String str.
• width - Width of the space where this string is drawn to

Return value

• Count of characters that fit into space that is width pixels wide

Exceptions

• InvalidRangeException - If the range is outside the str's bounds.

main
  Font f = system.get default font
  int charactersDisplayed = f.get size of "Test data" range 0 size 2 fitting into 10 pixels

  print "Amount of characters of text fitting into 10 pixels: " & charactersDisplayed