跳到主要内容

eui.TextInput

包    eui

类    public class TextInput

继承    eui.TextInput → eui.Component → egret.DisplayObjectContainer → egret.DisplayObject → egret.EventDispatcher → egret.HashObject

TextInput 是一个文本输入控件，供用户输入和编辑统一格式文本

公共属性​

属性
displayAsPassword : boolean
指定文本字段是否是密码文本字段
inputType : string
弹出键盘的类型
maxChars : number
文本字段中最多可包含的字符数（即用户输入的字符数）
maxHeight : number
组件的最大高度,同时影响测量和自动布局的尺寸
maxWidth : number
组件的最大高度
prompt : string
当text属性为空字符串时要显示的文本内容
promptDisplay : eui.Label
[SkinPart] When the property of the text is empty, it will show the defalut string.
restrict : string
表示用户可输入到文本字段中的字符集
text : string
作为文本字段中当前文本的字符串
textColor : number
文本颜色
textDisplay : eui.EditableText
[SkinPart] 实体文本输入组件

公共方法​

方法
TextInput()

事件​

Events
egret.Event.COMPLETE
当设置skinName为外部exml文件路径时，加载并完成EXML解析后调度。
egret.Event.RESIZE
当UI组件的尺寸发生改变时调度
eui.UIEvent.MOVE
当UI组件在父级容器中的位置发生改变时调度
eui.UIEvent.CREATION_COMPLETE
当UI组件第一次被添加到舞台并完成初始化后调度
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 实例上抬起接触点时（例如，按住屏幕上的某个对象,然后从它上面挪开后再松开手指）调度。

属性详细信息​

displayAsPassword​

displayAsPassword : boolean = false

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

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

inputType​

inputType : string

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

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

maxChars​

maxChars : number = 0

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

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

maxHeight​

maxHeight : number

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

组件的最大高度,同时影响测量和自动布局的尺寸。

maxWidth​

maxWidth : number

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

组件的最大高度。同时影响测量和自动布局的尺寸。

prompt​

prompt : string

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

当text属性为空字符串时要显示的文本内容。先创建文本控件时将显示提示文本。控件获得焦点时或控件的 text 属性为非空字符串时，提示文本将消失。控件失去焦点时提示文本将重新显示，但仅当未输入文本时（如果文本字段的值为空字符串）。对于文本控件，如果用户输入文本，但随后又将其删除，则控件失去焦点后，提示文本将重新显示。您还可以通过编程方式将文本控件的 text 属性设置为空字符串使提示文本重新显示。

promptDisplay​

promptDisplay : eui.Label

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

[SkinPart] When the property of the text is empty, it will show the defalut string.

restrict​

restrict : string = null

  • 支持版本:eui 1.0
  • 运行平台: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";

text​

text : string

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

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

textColor​

textColor : number = 0x000000

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

文本颜色

textDisplay​

textDisplay : eui.EditableText

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

[SkinPart] 实体文本输入组件

方法详细信息​

TextInput()​

public TextInput()

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

示例​

**

* 下面的例子显示了如何使用 eui.TextInput 类

*/

class  TextInputExample  extends  eui.Group{

constructor(){

super();

var textInputSkin =  `

<e:Skin class="skins.TextInputSkin" minHeight="40" minWidth="300" states="normal,disabled,normalWithPrompt,disabledWithPrompt" xmlns:e="http:/ns.egret.com/eui">

<e:Image width="100%" height="100%" scale9Grid="1,3,8,8" source="resource/button_up.png"/>

<e:Rect height="100%" width="100%" fillColor="0xffffff"/>

<e:EditableText id="textDisplay" verticalCenter="0" left="10" right="10"

textColor="0x000000" textColor.disabled="0xff0000" width="100%" height="24" size="20" />

<e:Label id="promptDisplay" verticalCenter="0" left="10" right="10"

textColor="0xa9a9a9" width="100%" height="24" size="20" touchEnabled="false" includeIn="normalWithPrompt,disabledWithPrompt"/>

</e:Skin>

`;

var textInput:eui.TextInput  =  new  eui.TextInput();

textInput.skinName  = textInputSkin;

this.addChild(textInput);

}

}