跳到主要内容

egret.TextField

包    egret

类    public class TextField

继承    egret.TextField → egret.DisplayObject → egret.EventDispatcher → egret.HashObject

子类    eui.EditableText,eui.Label

TextField是egret的文本渲染类，采用浏览器/设备的API进行渲染，在不同的浏览器/设备中由于字体渲染方式不一，可能会有渲染差异如果开发者希望所有平台完全无差异，请使用BitmapText

公共属性​

属性
background : boolean
指定文本字段是否具有背景填充
backgroundColor : number
文本字段背景的颜色
bold : boolean
是否显示为粗体
border : boolean
指定文本字段是否具有边框
borderColor : number
文本字段边框的颜色
default_fontFamily : string
[静态]默认文本字体
default_size : number
[静态]默认文本字号大小
default_textColor : number
[静态]默认文本颜色
displayAsPassword : boolean
指定文本字段是否是密码文本字段
fontFamily : string
要使用的字体的名称或用逗号分隔的字体名称列表
inputType : string
弹出键盘的类型
italic : boolean
是否显示为斜体
lineSpacing : number
一个整数，表示行与行之间的垂直间距量
maxChars : number
文本字段中最多可包含的字符数（即用户输入的字符数）
maxScrollV : number
scrollV 的最大值
multiline : boolean
表示字段是否为多行文本字段
numLines : number
文本行数
restrict : string
表示用户可输入到文本字段中的字符集
scrollV : number
文本在文本字段中的垂直位置
size : number
文本的字号大小
stroke : number
表示描边宽度
strokeColor : number
表示文本的描边颜色
text : string
作为文本字段中当前文本的字符串
textAlign : string
文本的水平对齐方式
textColor : number
文本颜色
textFlow : Array<egret.ITextElement>
设置富文本
textHeight : number
获取文本测量高度
textWidth : number
获取文本测量宽度
type : string
文本字段的类型
verticalAlign : string
文字的垂直对齐方式
wordWrap : boolean
一个布尔值，表示文本字段是否按单词换行

公共方法​

方法
TextField()
setFocus():void
输入文本自动进入到输入状态，仅在类型是输入文本并且是在用户交互下才可以调用

事件​

Events
egret.Event.CHANGE
输入文本有用户输入时调度。
egret.FocusEvent.FOCUS_IN
聚焦输入文本后调度。
egret.FocusEvent.FOCUS_OUT
输入文本失去焦点后调度。
egret.Event.ADDED
将显示对象添加到显示列表中时调度。
egret.Event.ADDED_TO_STAGE
在将显示对象直接添加到舞台显示列表或将包含显示对象的子树添加至舞台显示列表中时调度。
egret.Event.REMOVED
将要从显示列表中删除显示对象时调度。
egret.Event.REMOVED_FROM_STAGE
在从显示列表中直接删除显示对象或删除包含显示对象的子树时调度。
egret.Event.ENTER_FRAME
[广播事件] 播放头进入新帧时调度。
egret.Event.RENDER
[广播事件] 将要更新和呈现显示列表时调度。
egret.TouchEvent.TOUCH_MOVE
当用户触碰设备时进行调度，而且会连续调度，直到接触点被删除。
egret.TouchEvent.TOUCH_BEGIN
当用户第一次触摸启用触摸的设备时（例如，用手指触摸手机屏幕）调度。
egret.TouchEvent.TOUCH_END
当用户移除与启用触摸的设备的接触时（例如，将手指从屏幕上抬起）调度。
egret.TouchEvent.TOUCH_TAP =
当用户在启用触摸设备上的已启动接触的同一 DisplayObject 实例上抬起接触点时（例如，手机点击屏幕后抬起）调度。
egret.TouchEvent.TOUCH_RELEASE_OUTSIDE
当用户在启用触摸设备上的已启动接触的不同 DisplayObject 实例上抬起接触点时（例如，按住屏幕上的某个对象,然后从它上面挪开后再松开手指）调度。

属性详细信息​

background​

background : boolean = false

  • 支持版本:all
  • 运行平台:Web,Native

指定文本字段是否具有背景填充。如果为 true，则文本字段具有背景填充。如果为 false，则文本字段没有背景填充。使用 backgroundColor 属性来设置文本字段的背景颜色。

backgroundColor​

backgroundColor : number = 0xFFFFFF

  • 支持版本:all
  • 运行平台:Web,Native

文本字段背景的颜色。即使当前没有背景，也可检索或设置此属性，但只有当文本字段已将 background 属性设置为 true 时，才可以看到颜色。

bold​

bold : boolean = false

  • 支持版本:Egret 2.4
  • 运行平台:Web,Native

是否显示为粗体。

border​

border : boolean = false

  • 支持版本:all
  • 运行平台:Web,Native

指定文本字段是否具有边框。如果为 true，则文本字段具有边框。如果为 false，则文本字段没有边框。使用 borderColor 属性来设置边框颜色。

borderColor​

borderColor : number = 0x000000

  • 支持版本:all
  • 运行平台:Web,Native

文本字段边框的颜色。即使当前没有边框，也可检索或设置此属性，但只有当文本字段已将 border 属性设置为 true 时，才可以看到颜色。

default_fontFamily​

default_fontFamily : string = "Arial"

  • 支持版本:Egret 2.4
  • 运行平台:Web,Native

默认文本字体

default_size​

default_size : number = 30

  • 支持版本:Egret 3.2.1
  • 运行平台:Web,Native

默认文本字号大小

default_textColor​

default_textColor : number = 0xffffff

  • 支持版本:Egret 3.2.1
  • 运行平台:Web,Native

默认文本颜色

displayAsPassword​

displayAsPassword : boolean = false

  • 支持版本:all
  • 运行平台:Web,Native

指定文本字段是否是密码文本字段。如果此属性的值为 true，则文本字段被视为密码文本字段，并使用星号而不是实际字符来隐藏输入的字符。如果为 false，则不会将文本字段视为密码文本字段。

fontFamily​

fontFamily : string = "Arial"

  • 支持版本:Egret 2.4
  • 运行平台:Web,Native

要使用的字体的名称或用逗号分隔的字体名称列表。

inputType​

inputType : string

  • 支持版本:all
  • 运行平台:Web,Native

弹出键盘的类型。TextFieldInputType 常量中的任一个。

italic​

italic : boolean = false

  • 支持版本:Egret 2.4
  • 运行平台:Web,Native

是否显示为斜体。

lineSpacing​

lineSpacing : number = 0

  • 支持版本:Egret 2.4
  • 运行平台:Web,Native

一个整数，表示行与行之间的垂直间距量

maxChars​

maxChars : number = 0

  • 支持版本:all
  • 运行平台:Web,Native

文本字段中最多可包含的字符数（即用户输入的字符数）。脚本可以插入比 maxChars 允许的字符数更多的文本；maxChars 属性仅表示用户可以输入多少文本。如果此属性的值为 0，则用户可以输入无限数量的文本。

maxScrollV​

maxScrollV : number

  • 支持版本:Egret 2.4
  • 运行平台:Web,Native

scrollV 的最大值

multiline​

multiline : boolean = false

  • 支持版本:all
  • 运行平台:Web,Native

表示字段是否为多行文本字段。注意，此属性仅在type为TextFieldType.INPUT时才有效。如果值为 true，则文本字段为多行文本字段；如果值为 false，则文本字段为单行文本字段。在类型为 TextFieldType.INPUT 的字段中，multiline 值将确定 Enter 键是否创建新行（如果值为 false，则将忽略 Enter 键）。

numLines​

numLines : number

  • 支持版本:Egret 2.4
  • 运行平台:Web,Native

文本行数。

restrict​

restrict : string = null

  • 支持版本:Egret 2.4
  • 运行平台:Web,Native

表示用户可输入到文本字段中的字符集。如果 restrict 属性的值为 null，则可以输入任何字符。如果 restrict 属性的值为空字符串，则不能输入任何字符。如果 restrict 属性的值为一串字符，则只能在文本字段中输入该字符串中的字符。从左向右扫描该字符串。可以使用连字符 (-) 指定一个范围。只限制用户交互；脚本可将任何文本放入文本字段中。

如果字符串以尖号 (^) 开头，则先接受所有字符，然后从接受字符集中排除字符串中 ^ 之后的字符。如果字符串不以尖号 (^) 开头，则最初不接受任何字符，然后将字符串中的字符包括在接受字符集中。

下例仅允许在文本字段中输入大写字符、空格和数字：

my_txt.restrict = "A-Z 0-9";

下例包含除小写字母之外的所有字符：

my_txt.restrict = "^a-z";

如果需要输入字符 \ ^，请使用2个反斜杠 "-" "\^" ：

可在字符串中的任何位置使用 ^，以在包含字符与排除字符之间进行切换，但是最多只能有一个 ^ 用来排除。下面的代码只包含除大写字母 Q 之外的大写字母：

my_txt.restrict = "A-Z^Q";

scrollV​

scrollV : number

  • 支持版本:all
  • 运行平台:Web,Native

文本在文本字段中的垂直位置。scrollV 属性可帮助用户定位到长篇文章的特定段落，还可用于创建滚动文本字段。垂直滚动的单位是行，而水平滚动的单位是像素。如果显示的第一行是文本字段中的第一行，则 scrollV 设置为 1（而非 0）。

size​

size : number = 30

  • 支持版本:Egret 2.4
  • 运行平台:Web,Native

文本的字号大小。

stroke​

stroke : number = 0

  • 支持版本:all
  • 运行平台:Web,Native

表示描边宽度。0为没有描边。

strokeColor​

strokeColor : number = 0x000000

  • 支持版本:all
  • 运行平台:Web,Native

表示文本的描边颜色。包含三个 8 位 RGB 颜色成分的数字；例如，0xFF0000 为红色，0x00FF00 为绿色。

text​

text : string

  • 支持版本:all
  • 运行平台:Web,Native

作为文本字段中当前文本的字符串

textAlign​

textAlign : string

  • 支持版本:Egret 2.4
  • 运行平台:Web,Native

文本的水平对齐方式。

textColor​

textColor : number = 0x000000

  • 支持版本:Egret 2.4
  • 运行平台:Web,Native

文本颜色

textFlow​

textFlow : Array<egret.ITextElement>

  • 支持版本:all
  • 运行平台:Web,Native

设置富文本

textHeight​

textHeight : number

  • 支持版本:Egret 2.4
  • 运行平台:Web,Native

获取文本测量高度

textWidth​

textWidth : number

  • 支持版本:Egret 2.4
  • 运行平台:Web,Native

获取文本测量宽度

type​

type : string = egret.TextFieldType.DYNAMIC

  • 支持版本:all
  • 运行平台:Web,Native

文本字段的类型。以下 TextFieldType 常量中的任一个：TextFieldType.DYNAMIC（指定用户无法编辑的动态文本字段），或 TextFieldType.INPUT（指定用户可以编辑的输入文本字段）。

verticalAlign​

verticalAlign : string

  • 支持版本:Egret 2.4
  • 运行平台:Web,Native

文字的垂直对齐方式。

wordWrap​

wordWrap : boolean = false

  • 支持版本:Egret 2.4
  • 运行平台:Web,Native

一个布尔值，表示文本字段是否按单词换行。如果值为 true，则该文本字段按单词换行；如果值为 false，则该文本字段按字符换行。

方法详细信息​

TextField()​

public TextField()

  • 支持版本:Egret 2.4
  • 运行平台:Web,Native

setFocus()​

public setFocus():void

输入文本自动进入到输入状态，仅在类型是输入文本并且是在用户交互下才可以调用。

  • 支持版本:Egret 3.0.8
  • 运行平台:Web,Native

示例​

/*
 * 以下示例演示了使用 TextField 显示字体。
 */
class  TextFieldExample  extends  egret.DisplayObjectContainer  {
  public  constructor()  {
    super();
    //创建 TextField 对象
    var label:egret.TextField  =  new  egret.TextField();
    //设置显示背景
    label.background  =  true;
    //设置背景颜色
    label.backgroundColor  =  0xffffff;
    //设置显示边框
    label.border  =  true;
    //设置边框颜色
    label.borderColor  =  0x00ff00;
    //设置字体
    label.fontFamily  =  "Arial";
    //设置文本颜色
    label.textColor  =  0xFF0000;
    //设置字号
    label.size  =  30;
    //设置显示文本
    label.text  =  "Hello Egret";
    //添加到显示列表
    this.addChild(label);
  }
}