# BitmapText

Inheritance BitmapText Container View Module hilo/view/BitmapText Requires hilo/core/Class, hilo/core/Hilo, hilo/view/Container, hilo/view/Bitmap Source BitmapText.js
BitmapText support bitmap text function ,but only support single-line text

### Properties

Show Inherited Properties

| Property | Defined
--- | --- | ---
| glyphs:Object font glyph set of bitmap. | BitmapText
| letterSpacing:Number spacing of letter. | BitmapText
| text:String content of bitmap text. | BitmapText
| textAlign:String property values:left、center、right, default:left,Not writable,set this property by 'setTextAlign' | BitmapText
| align:String|Function The alignment of the view, the value must be one of Hilo.align enum. | View
| alpha:Number The opacity of the view, default value is 1. | View
| background:Object The background style to fill the view, can be css color, gradient or pattern of canvas | View
| boundsArea:Array The vertex points of the view, the points are relative to the center point. | View
| children:Array List of children elements of the container, readonly! | Container
| clipChildren:Boolean Whether clip children elements which are out of the container, default value is false. | Container
| depth:Number The z index of the view, readonly! | View
| drawable:Drawable The drawable object of the view. | View
| height:Number The height of the view, default value is 0. | View
| id:String The identifier for the view. | View
| mask:Graphics Sets a mask for the view. | View
| onUpdate:Function This method will call while the view need update(usually caused by ticker update). | View
| parent:Container The parent view of this view, readonly! | View
| pivotX:Number Position of the center point on the x axis of the view, default value is 0. | View
| pivotY:Number Position of the center point on the y axis of the view, default value is 0. | View
| pointerChildren:Boolean Whether children elements of the container can response to user interactive events, default value is true. | Container
| pointerEnabled:Boolean Is the view can receive DOM events, default value is true. | View
| rotation:Number The rotation of the view in angles, default value is 0. | View
| scaleX:Number The x axis scale factor of the view, default value is 1. | View
| scaleY:Number The y axis scale factor of the view, default value is 1. | View
| tint:Number The tint applied to the view，default is 0xFFFFFF.Only support in WebGL mode. | View
| transform:Matrix The transform of the view.If set the transform, x, y, scaleX, scaleY, rotation, pivotX, pivotY will be ignored.default is null. | View
| visible:Boolean The visibility of the view. | View
| width:Number The width of the view, default value is 0. | View
| x:Number The position of the view on the x axis relative to the local coordinates of the parent, default value is 0. | View
| y:Number The position of the view on the y axis relative to the local coordinates of the parent, default value is 0. | View

### Methods

Show Inherited Methods

| Method | Defined
--- | --- | ---
| BitmapText(properties:Object) Constructor | BitmapText
| hasGlyphs(str:String):Boolean detect whether can display the string by the currently assigned font provided | BitmapText
| setText(text:String):BitmapText set the content of bitmap text | BitmapText
| setTextAlign(textAlign):BitmapText set the textAlign of text。 | BitmapText
| createGlyphs(text:String, image:Image, col:Number, row:Number):BitmapText static easy way to generate a collection of glyphs | BitmapText
| addChild(child:View) Add child element at the top. | Container
| addChildAt(child:View, index:Number) Add child element at given index. | Container
| addTo(container:Container, index:Uint):View Add current view to a Contaner. | View
| contains(child:View) Return whether this container contains the parameter described child element. | Container
| fire(type:String, detail:Object):Boolean Send events. | View
| getBounds():Array Get the bounds of the view as a circumscribed rectangle and all vertex points relative to the coordinates of the stage. | View
| getChildAt(index:Number) Return child element at the given index. | Container
| getChildById(id:String) Return child element at the given id. | Container
| getChildIndex(child:View) Return index value of the given child element. | Container
| getNumChildren():Uint Return the amount of the children elements of the container. | Container
| getScaledHeight():Number Get the scaled height of the view. | View
| getScaledWidth():Number Get the scaled width of the view. | View
| getStage():Stage Get the stage object of the view. | View
| getViewAtPoint(x:Number, y:Number, usePolyCollision:Boolean, global:Boolean, eventMode:Boolean) Return object at the point positioned by given values on x axis and y axis. | Container
| hitTestObject(object:View, usePolyCollision:Boolean) Determining whether an object is in the circumscribed rectangle of current view. | View
| hitTestPoint(x:Number, y:Number, usePolyCollision:Boolean):Boolean Determining whether a point is in the circumscribed rectangle of current view. | View
| off(type:String, listener:Function):Object Remove one event listener. | View
| on(type:String, listener:Function, once:Boolean):Object Add an event listenser. | View
| removeAllChildren():Container Remove all children elements. | Container
| removeChild(child:View):View Remove the given child element. | Container
| removeChildAt(index:Int):View Remove element at the index. | Container
| removeChildById(id:String):View Remove child element by its id. | Container
| removeFromParent():View Remove current view from it's parent container | View
| render(renderer:Renderer, delta:Number) The render method of current view. | View
| setChildIndex(child:View, index:Number) Set the index of child element. | Container
| sortChildren(keyOrFunction:Object) Sort children elements by the given key or function. | Container
| swapChildren(child1:View, child2:View) Swap index between two child elements. | Container
| swapChildrenAt(index1:Number, index2:Number) Swap two children elements at given indexes. | Container
| toString():String Get a string representing current view. | View

### Property Detail

glyphs:Object
font glyph set of bitmap. format:{letter:{image:img, rect:[0,0,100,100]}}
letterSpacing:Number
spacing of letter. default:0
text:String
content of bitmap text. Not writable,set this value by 'setText'
textAlign:String
property values:left、center、right, default:left,Not writable,set this property by 'setTextAlign'

### Constructor

BitmapText(properties:Object)

parameters
properties:Object — the options of create Instance.It can contains all writable property

### Method Detail

[Static] createGlyphs(text:String, image:Image, col:Number, row:Number):BitmapText
easy way to generate a collection of glyphs

parameters
text:String — character text.
image:Image — character image.
col:Number — default:the length of string
row:Number — default:1

return
  BitmapText — BitmapText对象本身。链式调用支持。

hasGlyphs(str:String):Boolean
detect whether can display the string by the currently assigned font provided

parameters
str:String — to detect string

return
  Boolean — whether can display the string

setText(text:String):BitmapText
set the content of bitmap text

parameters
text:String — content

return
  BitmapText — BitmapText Instance,support chained calls

setTextAlign(textAlign):BitmapText
set the textAlign of text。

parameters
textAlign — value of textAlign:left、center、right

return
  BitmapText — itmapText Instance,support chained calls