Ycc Engine API文档

Class: MultiLineText

Ycc .UI. MultiLineText

new Ycc.UI.MultiLineText(option)

Ycc.UI.MultiLineText.class.js, line 30

多行文本UI

Name Type Description

option

object

所有可配置的配置项

Name	Type	Default	Description
`content`	string	""	内容
`color`	string	black	颜色
`rect`	Ycc.Math.Rect		文字的绘制区域。若超出长度，此区域会被修改
`wordBreak`	string	break-all	水平方向文字超出换行 `break-all` 超出即换行 `break-word` 在单词处换行 `no-break` 不换行，超出即隐藏默认为`no-break`
`overflow`	string	auto	垂直方向超出rect之后的显示方式 `hidden` -- 直接隐藏 `auto` -- 修改rect大小，完全显示

Extends

Ycc.UI.Base

Members

anchorXnumber

UI对象的锚点坐标。相对坐标。相对于rect的x 锚点坐标主要用于图形的旋转、平移、缩放

anchorYnumber

UI对象的锚点坐标。相对坐标。相对于rect的y 锚点坐标主要用于图形的旋转、平移、缩放

baseUIYcc.UI

基础绘图UI

belongToYcc.Layer

UI所属的图层

ctxnull

绘图环境

ctxCachenull

缓存的绘图环境

disableTypeObject

被禁用的事件类型。key为type，val为boolean

displayLinesArray.<string>

显示在文本框中的文本行。私有属性，不允许修改。

dpinumber

设备像素比

fillStylestring

填充颜色

ghostboolean

是否幽灵状态，默认false 幽灵状态的UI：只能用于显示，不可点击，事件也不会触发，其子元素的事件也不会触发，不能通过getUIFromPointer获取用于解决多个UI重叠时是否需要穿透，以点击被覆盖UI的问题

idnumber

UI的唯一ID

isShowRotateBeforeUIboolean

是否显示缩放之前的位置

lineWidthnumber

线条宽度

listenersObject

所有的监听器。key为type，val为listener数组。

namestring

UI实例的名字

onclickfunction

点击的监听。默认为null

oncomputeendfunction

计算属性后的hook

oncomputestartfunction

计算属性前的hook

ondragendfunction

拖拽结束的监听。默认为null

ondraggingfunction

拖拽的监听。默认为null

ondragstartfunction

拖拽开始的监听。默认为null

onmousedownfunction

鼠标按下的监听。默认为null

onmousemovefunction

鼠标移动的监听。默认为null

onmouseoutfunction

鼠标移出的监听。默认为null

onmouseoverfunction

鼠标移入的监听。默认为null

onmouseupfunction

鼠标抬起的监听。默认为null

onrenderendfunction

渲染后的hook

onrenderstartfunction

渲染前的hook

ontapfunction

点击事件的监听。默认为null

ontouchendfunction

触摸结束的监听。默认为null

ontouchmovefunction

触摸移动的监听。默认为null

ontouchstartfunction

触摸开始的监听。默认为null

opacitynumber

透明度

rectYcc.Math.Rect

UI的绘图区域

rectBgColorstring

容纳区的背景色

rectBorderColorstring

容纳区边框颜色

rectBorderWidthnumber

容纳区的边框宽度

rotationnumber

相对于锚点的旋转角度

showboolean

是否显示

stopAllEventboolean

只会阻止当前UI事件的触发，不会阻止其下面子元素事件的触发

stopEventBubbleUpboolean

默认情况下，UI阻止事件冒泡，但不会阻止事件传播给图层

stopTypeObject

被阻止的事件类型。key为type，val为boolean

strokeStylestring

线条颜色

userDatanull

用户自定义的数据

xnumber

x相对父级的位置

ynumber

y相对父级的位置

yccClass

构造器的引用，Ycc中的每个类都有此属性

Methods

inherited addChild(ui){Ycc.UI.Base} Ycc.UI.Base.class.js, line 354

添加子ui

Name	Type	Description
`ui`

Returns:

Type	Description
Ycc.UI.Base

inherited addListener(type, listener) Ycc.Listener.class.js, line 234

添加某个类型的监听器

Name	Type	Description
`type`	string
`listener`	function

inherited clone(){Ycc.UI} Ycc.UI.Base.class.js, line 650

克隆ui

Returns:

Type	Description
Ycc.UI

inherited computeUIProps() Ycc.UI.MultiLineText.class.js, line 76

计算UI的各种属性。此操作必须在绘制之前调用。
计算与绘制分离的好处是，在绘制UI之前就可以提前确定元素的各种信息，从而判断是否需要绘制。

inherited containDot(dot){boolean} Ycc.UI.Base.class.js, line 750

判断某个点是否在UI组件内默认根据ui的容纳区rect字段进行判断，子UI可以覆盖此方法

Name	Type	Description
`dot`	Ycc.Math.Dot	某个点的绝对坐标

Returns:

Type	Description
boolean

inherited disableEvent(type) Ycc.Listener.class.js, line 291

禁止某个事件触发

Name	Type	Description
`type`

inherited extend(option){Ycc.UI} Ycc.UI.Base.class.js, line 635

合并参数，只会合并对象中已存在的key

Name	Type	Description
`option`

Returns:

Type	Description
Ycc.UI

inherited getAbsolutePosition(){Ycc.Math.Rect} Ycc.UI.Base.class.js, line 676

获取UI的绝对坐标，主要考虑图层坐标注：此区域未经过旋转

Returns:

Type	Description
Ycc.Math.Rect

inherited getAbsolutePositionPolygon() Ycc.UI.Base.class.js, line 659

获取UI平移、旋转之后位置的多边形区域，子UI需覆盖此方法

inherited getAbsolutePositionRect(){Ycc.Math.Rect} Ycc.UI.Base.class.js, line 666

获取容纳UI的矩形区域，子UI可以覆盖此方法注：此区域未经过旋转

Returns:

Type	Description
Ycc.Math.Rect

inherited getDeepLevel() Ycc.UI.Base.class.js, line 757

获取当前UI在树结构中的深度

inherited getMaxContentInWidth(content, width){string} Ycc.UI.Base.class.js, line 613

给定宽度，获取能容纳的最长单行字符串

Name	Type	Description
`content`	string	文本内容
`width`	number	指定宽度

Returns:

Type	Description
string

inherited init(layer) Ycc.UI.Base.class.js, line 252

在某个图层中初始化UI

Name	Type	Description
`layer`	Layer	图层

inherited isOutOfRect(rect) Ycc.UI.Base.class.js, line 407

判断当前区域在某个区域外

Name	Type	Description
`rect`	Ycc.Math.Rect

inherited isOutOfStage(){boolean} Ycc.UI.Base.class.js, line 393

判断ui是否存在于舞台之外，渲染时可以不予渲染在compute之后使用，判断更准确

Returns:

Type	Description
boolean

inherited removeChild(ui) Ycc.UI.Base.class.js, line 365

删除子ui

Name	Type	Description
`ui`

inherited removeListener(type, listener) Ycc.Listener.class.js, line 276

移除某个类型的监听器

Name	Type	Description
`type`
`listener`

inherited removeSelf() Ycc.UI.Base.class.js, line 343

删除自身。若子类包含多个UI，需要重载

render(ctx) Ycc.UI.MultiLineText.class.js, line 222

渲染至ctx

Name	Type	Description
`ctx`

inherited renderDashBeforeUI(ctx) Ycc.UI.Base.class.js, line 334

绘制UI平移、旋转之前的位置，用虚线绘制需要子UI重载

Name	Type	Description
`ctx`		optional 绘图环境，非必传

inherited renderRectBgColor(absoluteRect) Ycc.UI.Base.class.js, line 286

渲染容纳区rect的背景色
开启离屏canvas后，此过程只会发生在离屏canvas中

Name	Type	Description
`absoluteRect`	Ycc.Math.Rect	容纳区的绝对位置

inherited renderRectBorder(absoluteRect) Ycc.UI.Base.class.js, line 311

渲染容纳区rect的边框
开启离屏canvas后，此过程只会发生在离屏canvas中

Name	Type	Description
`absoluteRect`	Ycc.Math.Rect	容纳区的绝对位置

inherited resumeEvent(type) Ycc.Listener.class.js, line 299

恢复某个事件的触发

Name	Type	Description
`type`

inherited scaleAndRotate() Ycc.UI.Base.class.js, line 377

坐标系的缩放和旋转。先缩放、再旋转。

TODO

子类渲染前需要调用此方法
多边形替换rect后，此方法废弃，不再调用

inherited stop(type) Ycc.Listener.class.js, line 246

阻止某个事件类型继续传递

Name	Type	Description
`type`

inherited transformByRotate(dot){Ycc.Math.Dot} Ycc.UI.Base.class.js, line 766

根据当前的锚点、旋转角度获取某个点的转换之后的坐标

Name	Type	Description
`dot`	Ycc.Math.Dot \| Array.<Ycc.Math.Dot>	需要转换的点，该点为相对坐标，相对于当前UI的父级

Returns:

Type	Description
Ycc.Math.Dot	转换后的点，该点为绝对坐标

inherited transformToAbsolute(dotOrArr){Ycc.Math.Dot|Array.<Ycc.Math.Dot>} Ycc.UI.Base.class.js, line 700

根据图层坐标和UI位置坐标，将某个点的相对坐标（相对于UI的父级），转换为舞台的绝对坐标

Name	Type	Description
`dotOrArr`	Ycc.Math.Dot \| Array.<Ycc.Math.Dot>

Returns:

Type	Description
Ycc.Math.Dot \| Array.<Ycc.Math.Dot>

inherited transformToLocal(dotOrArr){Ycc.Math.Dot|Array.<Ycc.Math.Dot>} Ycc.UI.Base.class.js, line 722

根据图层坐标和UI位置坐标，将某个点的绝对坐标，转换为相对于UI父级的相对坐标

Name	Type	Description
`dotOrArr`	Ycc.Math.Dot \| Array.<Ycc.Math.Dot>

Returns:

Type	Description
Ycc.Math.Dot \| Array.<Ycc.Math.Dot>

inherited triggerListener(type, data) Ycc.Listener.class.js, line 255

触发某一类型的监听器

Name	Type	Description
`type`
`data`

inherited triggerUIEventBubbleUp(type, x, y, originEvent){Array.<Ycc.UI>} Ycc.UI.Base.class.js, line 832

冒泡触发UI的事件

Name	Type	Description
`type`
`x`
`y`
`originEvent`		ycc事件所对应的原始事件

Returns:

Type	Description
Array.<Ycc.UI>	返回已触发事件的UI列表

Ycc Engine v0.0.7 API文档

Class: MultiLineText

new Ycc.UI.MultiLineText(option)

Extends

Members

anchorXnumber

anchorYnumber

baseUIYcc.UI

belongToYcc.Layer

ctxnull

ctxCachenull

disableTypeObject

displayLinesArray.<string>

dpinumber

fillStylestring

ghostboolean

idnumber

isShowRotateBeforeUIboolean

lineWidthnumber

listenersObject

namestring

onclickfunction

oncomputeendfunction

oncomputestartfunction

ondragendfunction

ondraggingfunction

ondragstartfunction

onmousedownfunction

onmousemovefunction

onmouseoutfunction

onmouseoverfunction

onmouseupfunction

onrenderendfunction

onrenderstartfunction

ontapfunction

ontouchendfunction

ontouchmovefunction

ontouchstartfunction

opacitynumber

rectYcc.Math.Rect

rectBgColorstring

rectBorderColorstring

rectBorderWidthnumber

rotationnumber

showboolean

stopAllEventboolean

stopEventBubbleUpboolean

stopTypeObject

strokeStylestring

userDatanull

xnumber

ynumber

yccClass

Methods

inherited addChild(ui){Ycc.UI.Base}

Returns:

inherited addListener(type, listener)

inherited clone(){Ycc.UI}

Returns:

inherited computeUIProps()

inherited containDot(dot){boolean}

Returns:

inherited disableEvent(type)

inherited extend(option){Ycc.UI}

Returns:

inherited getAbsolutePosition(){Ycc.Math.Rect}

Returns:

inherited getAbsolutePositionPolygon()

inherited getAbsolutePositionRect(){Ycc.Math.Rect}

Returns:

inherited getDeepLevel()

inherited getMaxContentInWidth(content, width){string}

Returns:

inherited init(layer)

inherited isOutOfRect(rect)

inherited isOutOfStage(){boolean}

Returns:

inherited removeChild(ui)

inherited removeListener(type, listener)

inherited removeSelf()