GODPAPER | All Packages | All Classes | Index | Frames No Frames |
BitmapFontTextFormat

Package | feathers.text
Class | public class BitmapFontTextFormat
Inheritance | BitmapFontTextFormat Object

Customizes a bitmap font for use by a `BitmapFontTextRenderer`.

See also

feathers.controls.text.BitmapFontTextRenderer

Public Properties

| Property | Defined By
--- | --- | ---
|  | align : String = left Determines the alignment of the text, either left, center, or right. | BitmapFontTextFormat
|  | color : uint The multiply color. | BitmapFontTextFormat
|  | font : BitmapFont The BitmapFont instance to use. | BitmapFontTextFormat
|  | fontName : String [read-only] | BitmapFontTextFormat
|  | isKerningEnabled : Boolean = true Determines if the kerning values defined in the BitmapFont instance will be used for layout. | BitmapFontTextFormat
|  | letterSpacing : Number = 0 The number of extra pixels between characters. | BitmapFontTextFormat
|  | size : Number The size at which to display the bitmap font. | BitmapFontTextFormat

Public Methods

| Method | Defined By
--- | --- | ---
|  | BitmapFontTextFormat(font:Object, size:Number, color:uint = 0xffffff, align:String) Constructor. | BitmapFontTextFormat

Property Detail

align | property

`public var align:String = left`

Determines the alignment of the text, either left, center, or right.

color | property |

`public var color:uint`

The multiply color.

font | property |

`public var font:BitmapFont`

The BitmapFont instance to use.

fontName | property |

`fontName:String` [read-only]

Implementation
`public function get fontName():String`

isKerningEnabled | property |

`public var isKerningEnabled:Boolean = true`

Determines if the kerning values defined in the BitmapFont instance will be used for layout.

letterSpacing | property |

`public var letterSpacing:Number = 0`

The number of extra pixels between characters. May be positive or negative.

size | property |

`public var size:Number`

The size at which to display the bitmap font. Set to `NaN` to use the default size in the BitmapFont instance.

Constructor Detail

BitmapFontTextFormat | () | Constructor

`public function BitmapFontTextFormat(font:Object, size:Number, color:uint = 0xffffff, align:String)`

Constructor.

Parameters

| `font:Object`
| `size:Number` (default = `NaN`)``
| `color:uint` (default = `0xffffff`)``
| `align:String` (default = `NaN`)``

Thu Jan 16 2014, 01:11 PM +08:00