Package | laya.display |
Class | public class Input |
Inheritance | Input Text Sprite Node EventDispatcher Object |
Input
类用于创建显示对象以显示和输入文本。
Input 类封装了原生的文本输入框,由于不同浏览器的差异,会导致此对象的默认文本的位置与用户点击输入时的文本的位置有少许的偏差。
Property | Defined By | ||
---|---|---|---|
align : String
表示文本的水平显示方式。
取值:
"left": 居左对齐显示。
"center": 居中对齐显示。
"right": 居右对齐显示。
| Text | ||
alpha : Number 透明度,值为0-1,默认值为1,表示不透明。更改alpha值会影响drawcall。 | Sprite | ||
asPassword : Boolean
本API已弃用。使用type="password"替代设置asPassword, asPassword将在下次重大更新时删去。
指定文本字段是否是密码文本字段。
如果此属性的值为 true,则文本字段被视为密码文本字段,并使用星号而不是实际字符来隐藏输入的字符。如果为 false,则不会将文本字段视为密码文本字段。
默认值为false。
| Input | ||
autoSize : Boolean = false
指定是否自动计算宽高数据。默认值为 false 。
Sprite宽高默认为0,并且不会随着绘制内容的变化而变化,如果想根据绘制内容获取宽高,可以设置本属性为true,或者通过getBounds方法获取。设置为true,对性能有一定影响。
| Sprite | ||
bgColor : String
文本背景颜色,以字符串表示。
| Text | ||
blendMode : String 指定要使用的混合模式。目前只支持"lighter"。 | Sprite | ||
bold : Boolean
指定文本是否为粗体字。
默认值为 false,这意味着不使用粗体字。如果值为 true,则文本为粗体字。
| Text | ||
borderColor : String
文本边框背景颜色,以字符串表示。
| Text | ||
cacheAs : String
指定显示对象是否缓存为静态图像,cacheAs时,子对象发生变化,会自动重新缓存,同时也可以手动调用reCache方法更新缓存。
建议把不经常变化的“复杂内容”缓存为静态图像,能极大提高渲染性能。cacheAs有"none","normal"和"bitmap"三个值可选。
默认为"none",不做任何缓存。
当值为"normal"时,canvas模式下进行画布缓存,webgl模式下进行命令缓存。
当值为"bitmap"时,canvas模式下进行依然是画布缓存,webgl模式下使用renderTarget缓存。
webgl下renderTarget缓存模式缺点:会额外创建renderTarget对象,增加内存开销,缓存面积有最大2048限制,不断重绘时会增加CPU开销。优点:大幅减少drawcall,渲染性能最高。
webgl下命令缓存模式缺点:只会减少节点遍历及命令组织,不会减少drawcall数,性能中等。优点:没有额外内存开销,无需renderTarget支持。
| Sprite | ||
cacheAsBitmap : Boolean
指定显示对象是否缓存为静态图像。功能同cacheAs的normal模式。建议优先使用cacheAs代替。
| Sprite | ||
CharacterCache : Boolean = true [static]
WebGL渲染文字时是否启用字符缓存,对于字形多的语种,禁用缓存。
对于字形随字母组合变化的语种,如阿拉伯文,启用将使显示错误。但是即使禁用,自动换行也会在错误的地方截断。
| Text | ||
color : String [override]
表示文本的颜色值。可以通过 Text.defaultColor 设置默认颜色。
默认值为黑色。
| Input | ||
customRenderEnable : Boolean [write-only]
设置是否开启自定义渲染,只有开启自定义渲染,才能使用customRender函数渲染。
| Sprite | ||
destroyed : Boolean [只读]是否已经销毁。对象销毁后不能再使用。 | Node | ||
displayedInStage : Boolean [read-only] 表示是否在显示列表中显示。 | Node | ||
editable : Boolean
是否可编辑。
| Input | ||
filters : Array 滤镜集合。可以设置多个滤镜组合。 | Sprite | ||
focus : Boolean
表示焦点是否在此实例上。
| Input | ||
font : String
文本的字体名称,以字符串形式表示。
默认值为:"Arial",可以通过Font.defaultFont设置默认字体。
如果运行时系统找不到设定的字体,则用系统默认的字体渲染文字,从而导致显示异常。(通常电脑上显示正常,在一些移动端因缺少设置的字体而显示异常)。
| Text | ||
fontSize : int
指定文本的字体大小(以像素为单位)。
默认为20像素,可以通过 Text.defaultSize 设置默认大小。
| Text | ||
globalScaleX : Number [read-only]
获得相对于stage的全局X轴缩放值(会叠加父亲节点的缩放值)。
| Sprite | ||
globalScaleY : Number [read-only]
获得相对于stage的全局Y轴缩放值(会叠加父亲节点的缩放值)。
| Sprite | ||
graphics : Graphics 绘图对象。封装了绘制位图和矢量图的接口,Sprite所有的绘图操作都通过Graphics来实现的。 | Sprite | ||
height : Number [override]
显示对象的高度,单位为像素,默认为0。
此高度用于鼠标碰撞检测,并不影响显示对象图像大小。需要对显示对象的图像进行缩放,请使用scale、scaleX、scaleY。
可以通过getbounds获取显示对象图像的实际高度。
| Text | ||
HIDDEN : String = hidden [static] hidden 不显示超出文本域的字符。 | Text | ||
hitArea : *
可以设置一个Rectangle区域作为点击区域,或者设置一个HitArea实例作为点击区域,HitArea内可以设置可点击和不可点击区域。
如果不设置hitArea,则根据宽高形成的区域进行碰撞。
| Sprite | ||
hitTestPrior : Boolean = false
指定鼠标事件检测是优先检测自身,还是优先检测其子对象。鼠标事件检测发生在鼠标事件的捕获阶段,此阶段引擎会从stage开始递归检测stage及其子对象,直到找到命中的目标对象或者未命中任何对象。
如果为false,优先检测子对象,当有子对象被命中时,中断检测,获得命中目标。如果未命中任何子对象,最后再检测此对象;如果为true,则优先检测本对象,如果本对象没有被命中,直接中断检测,表示没有命中目标;如果本对象被命中,则进一步递归检测其子对象,以确认最终的命中目标。
合理使用本属性,能减少鼠标事件检测的节点,提高性能。可以设置为true的情况:开发者并不关心此节点的子节点的鼠标事件检测结果,也就是以此节点作为其子节点的鼠标事件检测依据。
Stage对象和UI的View组件默认为true。
| Sprite | ||
inputElementXAdjuster : int
原生输入框 X 轴调整值,用来调整输入框坐标。
由于即使设置了该值,在各平台和浏览器之间也不一定一致,inputElementXAdjuster已弃用。
| Input | ||
inputElementYAdjuster : int
原生输入框 Y 轴调整值,用来调整输入框坐标。
由于即使设置了该值,在各平台和浏览器之间也不一定一致,inputElementYAdjuster已弃用。
| Input | ||
isInputting : Boolean = false [static] 表示是否处于输入状态。 | Input | ||
italic : Boolean
表示使用此文本格式的文本是否为斜体。
默认值为 false,这意味着不使用斜体。如果值为 true,则文本为斜体。
| Text | ||
langPacks : Object [static] 语言包 | Text | ||
leading : Number
垂直行间距(以像素为单位)。
| Text | ||
lines : Array [read-only] | Text | ||
mask : Sprite
遮罩,可以设置一个对象(支持位图和矢量图),根据对象形状进行遮罩显示。
【注意】遮罩对象坐标系是相对遮罩对象本身的,和Flash机制不同
| Sprite | ||
maxChars : int
字符数量限制,默认为10000。
设置字符数量限制时,小于等于0的值将会限制字符数量为10000。
| Input | ||
maxScrollX : int [read-only]
获取横向可滚动最大值。
| Text | ||
maxScrollY : int [read-only]
获取纵向可滚动最大值。
| Text | ||
mouseEnabled : Boolean
是否接受鼠标事件。
默认为false,如果监听鼠标事件,则会自动设置本对象及父节点的属性 mouseEnable 的值都为 true(如果父节点手动设置为false,则不会更改)。
| Sprite | ||
mouseThrough : Boolean = false
鼠标事件与此对象的碰撞检测是否可穿透。碰撞检测发生在鼠标事件的捕获阶段,此阶段引擎会从stage开始递归检测stage及其子对象,直到找到命中的目标对象或者未命中任何对象。
穿透表示鼠标事件发生的位置处于本对象绘图区域内时,才算命中,而与对象宽高和值为Rectangle对象的hitArea属性无关。如果sprite.hitArea值是HitArea对象,表示显式声明了此对象的鼠标事件响应区域,而忽略对象的宽高、mouseThrough属性。
影响对象鼠标事件响应区域的属性为:width、height、hitArea,优先级顺序为:hitArea(type:HitArea)>hitArea(type:Rectangle)>width/height。
| Sprite | ||
mouseX : Number [read-only]
返回鼠标在此对象坐标系上的 X 轴坐标信息。
| Sprite | ||
mouseY : Number [read-only]
返回鼠标在此对象坐标系上的 Y 轴坐标信息。
| Sprite | ||
multiline : Boolean 表示是否是多行输入框。 | Input | ||
name : String 节点名称。 | Node | ||
nativeInput : * [read-only]
获取对输入框的引用实例。
| Input | ||
numChildren : int [read-only]
子对象数量。
| Node | ||
optimizeScrollRect : Boolean
指定是否对使用了 scrollRect 的显示对象进行优化处理。默认为false(不优化)。
当值为ture时:将对此对象使用了scrollRect 设定的显示区域以外的显示内容不进行渲染,以提高性能(如果子对象有旋转缩放或者中心点偏移,则显示筛选会不精确)。
| Sprite | ||
overflow : String
overflow 指定文本超出文本域后的行为。其值为"hidden"、"visible"和"scroll"之一。
性能从高到低依次为:hidden > visible > scroll。
| Text | ||
padding : Array
边距信息。
数据格式:[上边距,右边距,下边距,左边距](边距以像素为单位)。
| Text | ||
parent : Node [override] | Sprite | ||
pivotX : Number X轴 轴心点的位置,单位为像素,默认为0。轴心点会影响对象位置,缩放中心,旋转中心。 | Sprite | ||
pivotY : Number Y轴 轴心点的位置,单位为像素,默认为0。轴心点会影响对象位置,缩放中心,旋转中心。 | Sprite | ||
prompt : String
设置输入提示符。
| Input | ||
promptColor : String
设置输入提示符颜色。
| Input | ||
restrict : String 限制输入的字符。 | Input | ||
RightToLeft : Boolean = false [static] 是否是从右向左的显示顺序 | Text | ||
rotation : Number 旋转角度,默认值为0。以角度为单位。 | Sprite | ||
scaleX : Number X轴缩放值,默认值为1。设置为负数,可以实现水平反转效果,比如scaleX=-1。 | Sprite | ||
scaleY : Number Y轴缩放值,默认值为1。设置为负数,可以实现垂直反转效果,比如scaleX=-1。 | Sprite | ||
SCROLL : String = scroll [static] scroll 不显示文本域外的字符像素,并且支持 scroll 接口。 | Text | ||
scrollRect : Rectangle
显示对象的滚动矩形范围,具有裁剪效果(如果只想限制子对象渲染区域,请使用viewport),设置optimizeScrollRect=true,可以优化裁剪区域外的内容不进行渲染。
srollRect和viewport的区别:
1.srollRect自带裁剪效果,viewport只影响子对象渲染是否渲染,不具有裁剪效果(性能更高)。
2.设置rect的x,y属性均能实现区域滚动效果,但scrollRect会保持0,0点位置不变。
| Sprite | ||
scrollX : Number
获取横向滚动量。
| Text | ||
scrollY : Number
获取纵向滚动量。
| Text | ||
skewX : Number 水平倾斜角度,默认值为0。以角度为单位。 | Sprite | ||
skewY : Number 垂直倾斜角度,默认值为0。以角度为单位。 | Sprite | ||
stage : Stage [read-only] 对舞台 stage 的引用。 | Sprite | ||
staticCache : Boolean
是否静态缓存此对象的当前帧的最终属性。为 true 时,子对象变化时不会自动更新缓存,但是可以通过调用 reCache 方法手动刷新。
注意: 1. | Sprite | ||
stroke : Number
描边宽度(以像素为单位)。
默认值0,表示不描边。
| Text | ||
strokeColor : String
描边颜色,以字符串表示。
默认值为 "#000000"(黑色);
| Text | ||
text : String [override] 当前文本的内容字符串。 | Input | ||
textHeight : Number [read-only]
表示文本的高度,以像素为单位。
| Text | ||
texture : Texture 设置一个Texture实例,并显示此图片(如果之前有其他绘制,则会被清除掉)。等同于graphics.clear();graphics.drawTexture() | Sprite | ||
textWidth : Number [read-only]
表示文本的宽度,以像素为单位。
| Text | ||
timer : Timer 时间控制器,默认为Laya.timer。 | Node | ||
transform : Matrix
对象的矩阵信息。通过设置矩阵可以实现节点旋转,缩放,位移效果。
矩阵更多信息请参考 Matrix
| Sprite | ||
type : String
输入框类型为Input静态常量之一。
TYPE_TEXT
TYPE_PASSWORD
TYPE_EMAIL
TYPE_URL
TYPE_NUMBER
TYPE_RANGE
TYPE_DATE
TYPE_MONTH
TYPE_WEEK
TYPE_TIME
TYPE_DATE_TIME
TYPE_DATE_TIME_LOCAL
平台兼容性参见http://www.w3school.com.cn/html5/html_5_form_input_types.asp。
| Input | ||
underline : Boolean = false
是否显示下划线。
| Text | ||
underlineColor : String | Text | ||
valign : String
表示文本的垂直显示方式。
取值:
"top": 居顶部对齐显示。
"middle": 居中对齐显示。
"bottom": 居底部对齐显示。
| Text | ||
viewport : Rectangle = null
视口大小,视口外的子对象,将不被渲染(如果想实现裁剪效果,请使用srollRect),合理使用能提高渲染性能。比如由一个个小图片拼成的地图块,viewport外面的小图片将不渲染
srollRect和viewport的区别:
1. | Sprite | ||
visible : Boolean 表示是否可见,默认为true。如果设置不可见,节点将不被渲染。 | Sprite | ||
VISIBLE : String = visible [static] visible不进行任何裁切。 | Text | ||
width : Number [override]
显示对象的宽度,单位为像素,默认为0。
此宽度用于鼠标碰撞检测,并不影响显示对象图像大小。需要对显示对象的图像进行缩放,请使用scale、scaleX、scaleY。
可以通过getbounds获取显示对象图像的实际宽度。
| Text | ||
wordWrap : Boolean
表示文本是否自动换行,默认为false。
若值为true,则自动换行;否则不自动换行。
| Text | ||
x : Number 表示显示对象相对于父容器的水平方向坐标值。 | Sprite | ||
y : Number 表示显示对象相对于父容器的垂直方向坐标值。 | Sprite | ||
zOrder : Number z排序,更改此值,则会按照值的大小对同一容器的所有对象重新排序。值越大,越靠上。默认为0,则根据添加顺序排序。 | Sprite |
Method | Defined By | ||
---|---|---|---|
Input() 创建一个新的 Input 类实例。 | Input | ||
添加子节点。
| Node | ||
添加子节点到指定的索引位置。
| Node | ||
addChildren(... args):void
批量增加子节点
| Node | ||
changeText(text:String):void [override] | Input | ||
clearTimer(caller:*, method:Function):void
清理定时器。功能同Laya.timer.clearTimer()。
| Node | ||
当前容器是否包含指定的 Node 节点对象 。
| Node | ||
customRender(context:RenderContext, x:Number, y:Number):void
自定义更新、呈现显示对象。一般用来扩展渲染模式,请合理使用,可能会导致在加速器上无法渲染。
注意不要在此函数内增加或删除树节点,否则会对树节点遍历造成影响。
| Sprite | ||
destroy(destroyChild:Boolean = true):void [override]
销毁此对象。destroy对象默认会把自己从父节点移除,并且清理自身引用关系,等待js自动垃圾回收机制回收。destroy后不能再使用。
destroy时会移除自身的事情监听,自身的timer监听,移除子对象及从父节点移除自己。
| Text | ||
destroyChildren():void
销毁所有子对象,不销毁自己本身。
| Node | ||
drawToCanvas(canvasWidth:Number, canvasHeight:Number, offsetX:Number, offsetY:Number):HTMLCanvas
绘制 当前Sprite 到 Canvas 上,并返回一个HtmlCanvas。
绘制的结果可以当作图片源,再次绘制到其他Sprite里面,示例:
var htmlCanvas:HTMLCanvas = sprite.drawToCanvas(100, 100, 0, 0);//把精灵绘制到canvas上面
var texture:Texture = new Texture(htmlCanvas);//使用htmlCanvas创建Texture
var sp:Sprite = new Sprite().pos(0, 200);//创建精灵并把它放倒200位置
sp.graphics.drawTexture(texture);//把截图绘制到精灵上
Laya.stage.addChild(sp);//把精灵显示到舞台
也可以获取原始图片数据,分享到网上,从而实现截图效果,示例:
var htmlCanvas:HTMLCanvas = sprite.drawToCanvas(100, 100, 0, 0);//把精灵绘制到canvas上面
var canvas:= htmlCanvas.getCanvas();//获取原生的canvas对象
trace(canvas.toDataURL("image/png"));//打印图片base64信息,可以发给服务器或者保存为图片
| Sprite | ||
event(type:String, data:* = null):Boolean
派发事件。
| EventDispatcher | ||
frameLoop(delay:int, caller:*, method:Function, args:Array = null, coverBefore:Boolean = true):void
定时重复执行某函数(基于帧率)。功能同Laya.timer.frameLoop()。
| Node | ||
frameOnce(delay:int, caller:*, method:Function, args:Array = null, coverBefore:Boolean = true):void
定时执行一次某函数(基于帧率)。功能同Laya.timer.frameOnce()。
| Node | ||
[static]
根据图片地址创建一个新的 Sprite 对象用于加载并显示此图片。
| Sprite | ||
将父容器坐标系坐标转换到本地坐标系。
| Sprite | ||
获取本对象在父容器坐标系的矩形显示区域。
注意: 1.计算量较大,尽量少用,如果需要频繁使用,可以通过手动设置 setBounds 来缓存自身边界信息,从而避免比较消耗性能的计算。2. | Sprite | ||
返回字符在本类实例的父坐标系下的坐标。
| Text | ||
getChildAt(index:int):Node
根据子节点的索引位置,获取子节点对象。
| Node | ||
getChildByName(name:String):Node
根据子节点的名字,获取子节点对象。
| Node | ||
getChildIndex(node:Node):int
根据子节点对象,获取子节点的索引位置。
| Node | ||
getGraphicBounds(realSize:Boolean = false):Rectangle [override]
返回此实例中的绘图对象( Graphics )的显示区域,不包括子对象。
| Text | ||
获得相对于本对象上的鼠标坐标信息。 | Sprite | ||
获取对象在自身坐标系的边界范围。与 setBounds 对应。
注意:计算量较大,尽量少用,如果需要频繁使用,可以提前手动设置 setBounds 来缓存自身边界信息,从而避免比较消耗性能的计算。
| Sprite | ||
把stage的全局坐标转换为本地坐标。
| Sprite | ||
hasListener(type:String):Boolean
检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。
| EventDispatcher | ||
hitTestPoint(x:Number, y:Number):Boolean
检测某个点是否在此对象内。
| Sprite | ||
isMouseEvent(type:String):Boolean
检测指定事件类型是否是鼠标事件。
| EventDispatcher | ||
lang(text:String, arg1:* = null, arg2:* = null, arg3:* = null, arg4:* = null, arg5:* = null, arg6:* = null, arg7:* = null, arg8:* = null, arg9:* = null, arg10:* = null):void
根据指定的文本,从语言包中取当前语言的文本内容。并对此文本中的{i}文本进行替换。
设置Text.langPacks语言包后,即可使用lang获取里面的语言
例如:
(1)text 的值为“我的名字”,先取到这个文本对应的当前语言版本里的值“My name”,将“My name”设置为当前文本的内容。
(2)text 的值为“恭喜你赢得{0}个钻石,{1}经验。”,arg1 的值为100,arg2 的值为200。
则先取到这个文本对应的当前语言版本里的值“Congratulations on your winning {0} diamonds, {1} experience.”,
然后将文本里的{0}、{1},依据括号里的数字从0开始替换为 arg1、arg2 的值。
将替换处理后的文本“Congratulations on your winning 100 diamonds, 200 experience.”设置为当前文本的内容。
| Text | ||
loadImage(url:String, x:Number = 0, y:Number = 0, width:Number = 0, height:Number = 0, complete:Handler = null):Sprite
加载并显示一个图片。功能等同于graphics.loadImage方法。支持异步加载。
注意:多次调用loadImage绘制不同的图片,会同时显示。
| Sprite | ||
把本地坐标转换为相对stage的全局坐标。
| Sprite | ||
off(type:String, caller:*, listener:Function, onceOnly:Boolean = false):EventDispatcher
从 EventDispatcher 对象中删除侦听器。
| EventDispatcher | ||
offAll(type:String = null):EventDispatcher
从 EventDispatcher 对象中删除指定事件类型的所有侦听器。
| EventDispatcher | ||
on(type:String, caller:*, listener:Function, args:Array = null):EventDispatcher [override]
增加事件侦听器,以使侦听器能够接收事件通知。
如果侦听鼠标事件,则会自动设置自己和父亲节点的属性 mouseEnabled 的值为 true(如果父节点mouseEnabled=false,则停止设置父节点mouseEnabled属性)。
| Sprite | ||
once(type:String, caller:*, listener:Function, args:Array = null):EventDispatcher [override]
增加事件侦听器,以使侦听器能够接收事件通知,此侦听事件响应一次后则自动移除侦听。
如果侦听鼠标事件,则会自动设置自己和父亲节点的属性 mouseEnabled 的值为 true(如果父节点mouseEnabled=false,则停止设置父节点mouseEnabled属性)。
| Sprite | ||
parentRepaint():void cacheAs时,设置所有父对象缓存失效。 | Sprite | ||
设置轴心点。相当于分别设置pivotX和pivotY属性。
因为返回值为Sprite对象本身,所以可以使用如下语法:spr.pivot(...).pos(...);
| Sprite | ||
设置坐标位置。相当于分别设置x和y属性。
因为返回值为Sprite对象本身,所以可以使用如下语法:spr.pos(...).scale(...);
| Sprite | ||
reCache():void 在设置cacheAs的情况下,调用此方法会重新刷新缓存。 | Sprite | ||
registerBitmapFont(name:String, bitmapFont:BitmapFont):void [static]
注册位图字体。
| Text | ||
删除子节点。
| Node | ||
removeChildAt(index:int):Node
根据子节点索引位置,删除对应的子节点对象。
| Node | ||
removeChildByName(name:String):Node
根据子节点名字删除对应的子节点对象,如果找不到不会抛出异常。
| Node | ||
removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):Node
删除指定索引区间的所有子对象。
| Node | ||
从父容器删除自己,如已经被删除不会抛出异常。
| Node | ||
render(context:RenderContext, x:Number, y:Number):void [override]
更新、呈现显示对象。由系统调用。
| Input | ||
repaint():void cacheAs后,设置自己和父对象缓存失效。 | Sprite | ||
替换子节点。
| Node | ||
设置缩放。相当于分别设置scaleX和scaleY属性。
因为返回值为Sprite对象本身,所以可以使用如下语法:spr.scale(...).pos(...);
| Sprite | ||
select():void 选中当前实例的所有文本。 | Input | ||
设置对象在自身坐标系下的边界范围。与 getSelfBounds 对应。当 autoSize==true 时,会影响对象宽高。设置后,当需要获取自身边界范围时,就不再需要计算,合理使用能提高性能。比如 getBounds 会优先使用 setBounds 指定的值,如果没有指定则进行计算,此计算会对性能消耗比较大。
注意: setBounds 与 getBounds 并非对应相等关系, getBounds 获取的是本对象在父容器坐标系下的边界范围,通过设置 setBounds 会影响 getBounds 的结果。
| Sprite | ||
设置子节点的索引位置。
| Node | ||
setSelection(startIndex:int, endIndex:int):void
设置光标位置和选取字符。
| Input | ||
setTextRightToLeft():void [static]
设置文字排版模式为右到左。
| Text | ||
设置宽高。相当于分别设置width和height属性。
因为返回值为Sprite对象本身,所以可以使用如下语法:spr.size(...).pos(...);
| Sprite | ||
设置倾斜角度。相当于分别设置skewX和skewY属性。
因为返回值为Sprite对象本身,所以可以使用如下语法:spr.skew(...).pos(...);
| Sprite | ||
startDrag(area:Rectangle = null, hasInertia:Boolean = false, elasticDistance:Number = 0, elasticBackTime:int = 300, data:* = null, disableMouseEvent:Boolean = false, ratio:Number = 0.92):void
开始拖动此对象。
| Sprite | ||
stopDrag():void 停止拖动此对象。 | Sprite | ||
supportFont(font:String):Boolean [static]
判断系统是否支持指定的font。
| Text | ||
timerLoop(delay:int, caller:*, method:Function, args:Array = null, coverBefore:Boolean = true, jumpFrame:Boolean = false):void
定时重复执行某函数。功能同Laya.timer.timerLoop()。
| Node | ||
timerOnce(delay:int, caller:*, method:Function, args:Array = null, coverBefore:Boolean = true):void
定时执行某函数一次。功能同Laya.timer.timerOnce()。
| Node | ||
将本地坐标系坐标转转换到父容器坐标系。
| Sprite | ||
typeset():void
排版文本。
进行宽高计算,渲染、重绘文本。
| Text | ||
unregisterBitmapFont(name:String, destroy:Boolean = true):void [static]
移除注册的位图字体文件。
| Text | ||
updateZOrder():void 根据zOrder进行重新排序。 | Sprite |
Event | Summary | Defined By | ||
---|---|---|---|---|
添加到父对象后调度。 | Node | |||
显示对象失去焦点后调度。 | Input | |||
文本内容发生改变后调度。 | Text | |||
鼠标点击对象后调度。 | Sprite | |||
加入节点树时调度。 | Node | |||
拖动结束后调度。 | Sprite | |||
拖动中调度。 | Sprite | |||
开始拖动后调度。 | Sprite | |||
用户在输入框内敲回车键后,将会调度 enter 事件。 | Input | |||
显示对象获得焦点后调度。 | Input | |||
用户输入一个或多个文本字符时后调度。 | Input | |||
在显示对象上按下后调度。 | Sprite | |||
鼠标在对象身上进行移动后调度 | Sprite | |||
鼠标离开对象后调度。 | Sprite | |||
鼠标经过对象后调度。 | Sprite | |||
在显示对象抬起后调度。 | Sprite | |||
被父对象移除后调度。 | Node | |||
从节点树移除时调度。 | Node |
Constant | Defined By | ||
---|---|---|---|
TYPE_DATE : String = date [static] 选取日、月、年。 | Input | ||
TYPE_DATE_TIME : String = datetime [static] datetime - 选取时间、日、月、年(UTC 时间)。 | Input | ||
TYPE_DATE_TIME_LOCAL : String = datetime-local [static] datetime-local - 选取时间、日、月、年(本地时间)。 | Input | ||
TYPE_EMAIL : String = email [static] email 类型用于应该包含 e-mail 地址的输入域。 | Input | ||
TYPE_MONTH : String = month [static] month - 选取月、年。 | Input | ||
TYPE_NUMBER : String = number [static] number 类型用于应该包含数值的输入域。 | Input | ||
TYPE_PASSWORD : String = password [static] password 类型用于密码域输入。 | Input | ||
TYPE_RANGE : String = range [static]
range 类型用于应该包含一定范围内数字值的输入域。
range 类型显示为滑动条。
您还能够设定对所接受的数字的限定。
| Input | ||
TYPE_SEARCH : String = search [static]
search 类型用于搜索域,比如站点搜索或 Google 搜索。
search 域显示为常规的文本域。
| Input | ||
TYPE_TEXT : String = text [static] 常规文本域。 | Input | ||
TYPE_TIME : String = time [static] time - 选取时间(小时和分钟)。 | Input | ||
TYPE_URL : String = url [static] url 类型用于应该包含 URL 地址的输入域。 | Input | ||
TYPE_WEEK : String = week [static] week - 选取周和年。 | Input |
asPassword | property |
asPassword:Boolean
本API已弃用。使用type="password"替代设置asPassword, asPassword将在下次重大更新时删去。
指定文本字段是否是密码文本字段。
如果此属性的值为 true,则文本字段被视为密码文本字段,并使用星号而不是实际字符来隐藏输入的字符。如果为 false,则不会将文本字段视为密码文本字段。
默认值为false。
public function get asPassword():Boolean
public function set asPassword(value:Boolean):void
color | property |
color:String
[override]
表示文本的颜色值。可以通过 Text.defaultColor
设置默认颜色。
默认值为黑色。
public function get color():String
public function set color(value:String):void
editable | property |
editable:Boolean
是否可编辑。
public function get editable():Boolean
public function set editable(value:Boolean):void
focus | property |
focus:Boolean
表示焦点是否在此实例上。
public function get focus():Boolean
public function set focus(value:Boolean):void
inputElementXAdjuster | property |
inputElementXAdjuster:int
原生输入框 X 轴调整值,用来调整输入框坐标。
由于即使设置了该值,在各平台和浏览器之间也不一定一致,inputElementXAdjuster已弃用。
public function get inputElementXAdjuster():int
public function set inputElementXAdjuster(value:int):void
inputElementYAdjuster | property |
inputElementYAdjuster:int
原生输入框 Y 轴调整值,用来调整输入框坐标。
由于即使设置了该值,在各平台和浏览器之间也不一定一致,inputElementYAdjuster已弃用。
public function get inputElementYAdjuster():int
public function set inputElementYAdjuster(value:int):void
isInputting | property |
public static var isInputting:Boolean = false
表示是否处于输入状态。
maxChars | property |
maxChars:int
字符数量限制,默认为10000。
设置字符数量限制时,小于等于0的值将会限制字符数量为10000。
public function get maxChars():int
public function set maxChars(value:int):void
multiline | property |
multiline:Boolean
表示是否是多行输入框。
public function get multiline():Boolean
public function set multiline(value:Boolean):void
nativeInput | property |
nativeInput:*
[read-only] 获取对输入框的引用实例。
public function get nativeInput():*
prompt | property |
prompt:String
设置输入提示符。
public function get prompt():String
public function set prompt(value:String):void
promptColor | property |
promptColor:String
设置输入提示符颜色。
public function get promptColor():String
public function set promptColor(value:String):void
restrict | property |
restrict:String
限制输入的字符。
public function get restrict():String
public function set restrict(value:String):void
text | property |
text:String
[override] 当前文本的内容字符串。
public function get text():String
public function set text(value:String):void
type | property |
type:String
输入框类型为Input静态常量之一。
平台兼容性参见http://www.w3school.com.cn/html5/html_5_form_input_types.asp。
public function get type():String
public function set type(value:String):void
Input | () | Constructor |
public function Input()
创建一个新的 Input
类实例。
changeText | () | method |
override public function changeText(text:String):void
Parameters
text:String |
render | () | method |
override public function render(context:RenderContext, x:Number, y:Number):void
更新、呈现显示对象。由系统调用。
Parameters
context:RenderContext — 渲染的上下文引用。
| |
x:Number — X轴坐标。
| |
y:Number — Y轴坐标。
|
select | () | method |
public function select():void
选中当前实例的所有文本。
setSelection | () | method |
public function setSelection(startIndex:int, endIndex:int):void
设置光标位置和选取字符。
Parameters
startIndex:int — 光标起始位置。
| |
endIndex:int — 光标结束位置。
|
blur | Event |
enter | Event |
focus | Event |
input | Event |
TYPE_DATE | Constant |
public static const TYPE_DATE:String = date
选取日、月、年。
TYPE_DATE_TIME | Constant |
public static const TYPE_DATE_TIME:String = datetime
datetime - 选取时间、日、月、年(UTC 时间)。
TYPE_DATE_TIME_LOCAL | Constant |
public static const TYPE_DATE_TIME_LOCAL:String = datetime-local
datetime-local - 选取时间、日、月、年(本地时间)。
TYPE_EMAIL | Constant |
public static const TYPE_EMAIL:String = email
email 类型用于应该包含 e-mail 地址的输入域。
TYPE_MONTH | Constant |
public static const TYPE_MONTH:String = month
month - 选取月、年。
TYPE_NUMBER | Constant |
public static const TYPE_NUMBER:String = number
number 类型用于应该包含数值的输入域。
TYPE_PASSWORD | Constant |
public static const TYPE_PASSWORD:String = password
password 类型用于密码域输入。
TYPE_RANGE | Constant |
public static const TYPE_RANGE:String = range
range 类型用于应该包含一定范围内数字值的输入域。
range 类型显示为滑动条。
您还能够设定对所接受的数字的限定。
TYPE_SEARCH | Constant |
public static const TYPE_SEARCH:String = search
search 类型用于搜索域,比如站点搜索或 Google 搜索。
search 域显示为常规的文本域。
TYPE_TEXT | Constant |
public static const TYPE_TEXT:String = text
常规文本域。
TYPE_TIME | Constant |
public static const TYPE_TIME:String = time
time - 选取时间(小时和分钟)。
TYPE_URL | Constant |
public static const TYPE_URL:String = url
url 类型用于应该包含 URL 地址的输入域。
TYPE_WEEK | Constant |
public static const TYPE_WEEK:String = week
week - 选取周和年。