Widget 类型

继承于 Component

模块: cc

Widget 组件，用于设置和适配其相对于父节点的边距，Widget 通常被用于 UI 界面，也可以用于其他地方。Widget 会自动调整当前节点的坐标和宽高，不过目前调整后的结果要到下一帧才能在脚本里获取到，除非你先手动调用 updateAlignment。

索引

属性（properties）

• target Node 指定一个对齐目标，只能是当前节点的其中一个父节点，默认为空，为空时表示当前父节点。
• isAlignTop Boolean 是否对齐上边。
• isAlignVerticalCenter Boolean 是否垂直方向对齐中点，开启此项会将垂直方向其他对齐选项取消。
• isAlignBottom Boolean 是否对齐下边。
• isAlignLeft Boolean 是否对齐左边
• isAlignHorizontalCenter Boolean 是否水平方向对齐中点，开启此选项会将水平方向其他对齐选项取消。
• isAlignRight Boolean 是否对齐右边。
• isStretchWidth Boolean 当前是否水平拉伸。
• isStretchHeight Boolean 当前是否垂直拉伸。
• top Number 本节点顶边和父节点顶边的距离，可填写负值，只有在 isAlignTop 开启时才有作用。
• bottom Number 本节点底边和父节点底边的距离，可填写负值，只有在 isAlignBottom 开启时才有作用。
• left Number 本节点左边和父节点左边的距离，可填写负值，只有在 isAlignLeft 开启时才有作用。
• right Number 本节点右边和父节点右边的距离，可填写负值，只有在 isAlignRight 开启时才有作用。
• horizontalCenter Number 水平居中的偏移值，可填写负值，只有在 isAlignHorizontalCenter 开启时才有作用。
• verticalCenter Number 垂直居中的偏移值，可填写负值，只有在 isAlignVerticalCenter 开启时才有作用。
• isAbsoluteHorizontalCenter Boolean 如果为 true，"horizontalCenter" 将会以像素作为偏移值，反之为百分比（0 到 1）。
• isAbsoluteVerticalCenter Boolean 如果为 true，"verticalCenter" 将会以像素作为偏移值，反之为百分比（0 到 1）。
• isAbsoluteTop Boolean 如果为 true，"top" 将会以像素作为边距，否则将会以相对父物体高度的百分比（0 到 1）作为边距。
• isAbsoluteBottom Boolean 如果为 true，"bottom" 将会以像素作为边距，否则将会以相对父物体高度的百分比（0 到 1）作为边距。
• isAbsoluteLeft Boolean 如果为 true，"left" 将会以像素作为边距，否则将会以相对父物体宽度的百分比（0 到 1）作为边距。
• isAbsoluteRight Boolean 如果为 true，"right" 将会以像素作为边距，否则将会以相对父物体宽度的百分比（0 到 1）作为边距。
• alignMode Widget.AlignMode 指定 Widget 的对齐模式，用于决定 Widget 应该何时刷新。
• _alignFlags Number : 对齐开关，由 AlignFlags 组成
• isAlignOnce Boolean 开启后仅会在 onEnable 的当帧结束时对齐一次，然后立刻禁用当前组件。
• __eventTargets Array Register all related EventTargets,…
• node Node 该组件被附加到的节点。
• uuid String 组件的 uuid，用于编辑器。
• _enabled Boolean
• enabled Boolean 表示该组件自身是否启用。
• enabledInHierarchy Boolean 表示该组件是否被启用并且所在的节点也处于激活状态。
• _isOnLoadCalled Number 返回一个值用来判断 onLoad 是否被调用过，不等于 0 时调用过，等于 0 时未调用。
• _name String
• _objFlags Number
• name String 该对象的名称。
• isValid Boolean 表示该对象是否可用（被 destroy 后将不可用）。

方法

• updateAlignment 立刻执行 widget 对齐操作。
• update 如果该组件启用，则每帧调用 update。
• lateUpdate 如果该组件启用，则每帧调用 LateUpdate。
• __preload __preload is called before every onLoad….
• onLoad 当附加到一个激活的节点上或者其节点第一次激活时候调用。
• start 如果该组件第一次启用，则在所有组件的 update 之前调用。
• onEnable 当该组件被启用，并且它的节点也激活时。
• onDisable 当该组件被禁用或节点变为无效时调用。
• onDestroy 该方法为生命周期方法，父类未必会有实现。
• onFocusInEditor
• onLostFocusInEditor
• resetInEditor 用来初始化组件或节点的一些属性，当该组件被第一次添加到节点上或用户点击了它的 Reset 菜单时调用。
• addComponent 向节点添加一个组件类，你还可以通过传入脚本的名称来添加组件。
• getComponent 获取节点上指定类型的组件，如果节点有附加指定类型的组件，则返回，如果没有则为空。
• getComponents 返回节点上指定类型的所有组件。
• getComponentInChildren 递归查找所有子节点中第一个匹配指定类型的组件。
• getComponentsInChildren 递归查找自身或所有子节点中指定类型的组件
• _getLocalBounds 以便编辑器的场景视图可以正确地执行点选测试。
• onRestore onRestore 是用户在检查器菜单点击 Reset 时，对此组件执行撤消操作后调用的。
• schedule 调度一个自定义的回调函数。
• scheduleOnce 调度一个只运行一次的回调函数，可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。
• unschedule 取消调度一个自定义的回调函数。
• unscheduleAllCallbacks 取消调度所有已调度的回调函数：定制的回调函数以及 'update' 回调函数。
• destroy 销毁该对象，并释放所有它对其它对象的引用。
• _destruct Clear all references in the instance….
• _onPreDestroy Called before the object being destroyed.
• _serialize The customized serialization for this object. (Editor Only)
• _deserialize Init this object from the custom serialized data.

Details

属性（properties）

target

指定一个对齐目标，只能是当前节点的其中一个父节点，默认为空，为空时表示当前父节点。

isAlignTop

是否对齐上边。

isAlignVerticalCenter

是否垂直方向对齐中点，开启此项会将垂直方向其他对齐选项取消。

isAlignBottom

是否对齐下边。

isAlignLeft

是否对齐左边

isAlignHorizontalCenter

是否水平方向对齐中点，开启此选项会将水平方向其他对齐选项取消。

isAlignRight

是否对齐右边。

isStretchWidth

当前是否水平拉伸。当同时启用左右对齐时，节点将会被水平拉伸，此时节点的宽度只读。

isStretchHeight

当前是否垂直拉伸。当同时启用上下对齐时，节点将会被垂直拉伸，此时节点的高度只读。

top

本节点顶边和父节点顶边的距离，可填写负值，只有在 isAlignTop 开启时才有作用。

bottom

本节点底边和父节点底边的距离，可填写负值，只有在 isAlignBottom 开启时才有作用。

left

本节点左边和父节点左边的距离，可填写负值，只有在 isAlignLeft 开启时才有作用。

right

本节点右边和父节点右边的距离，可填写负值，只有在 isAlignRight 开启时才有作用。

horizontalCenter

水平居中的偏移值，可填写负值，只有在 isAlignHorizontalCenter 开启时才有作用。

verticalCenter

垂直居中的偏移值，可填写负值，只有在 isAlignVerticalCenter 开启时才有作用。

isAbsoluteHorizontalCenter

如果为 true，"horizontalCenter" 将会以像素作为偏移值，反之为百分比（0 到 1）。

isAbsoluteVerticalCenter

如果为 true，"verticalCenter" 将会以像素作为偏移值，反之为百分比（0 到 1）。

isAbsoluteTop

如果为 true，"top" 将会以像素作为边距，否则将会以相对父物体高度的百分比（0 到 1）作为边距。

isAbsoluteBottom

如果为 true，"bottom" 将会以像素作为边距，否则将会以相对父物体高度的百分比（0 到 1）作为边距。

isAbsoluteLeft

如果为 true，"left" 将会以像素作为边距，否则将会以相对父物体宽度的百分比（0 到 1）作为边距。

isAbsoluteRight

如果为 true，"right" 将会以像素作为边距，否则将会以相对父物体宽度的百分比（0 到 1）作为边距。

alignMode

指定 Widget 的对齐模式，用于决定 Widget 应该何时刷新。

示例

widget.alignMode = cc.Widget.AlignMode.ON_WINDOW_RESIZE;

_alignFlags

: 对齐开关，由 AlignFlags 组成

isAlignOnce

开启后仅会在 onEnable 的当帧结束时对齐一次，然后立刻禁用当前组件。这样便于脚本或动画继续控制当前节点。注意：onEnable 时所在的那一帧仍然会进行对齐。

__eventTargets

Register all related EventTargets,all event callbacks will be removed in _onPreDestroy

node

该组件被附加到的节点。组件总会附加到一个节点。

示例

cc.log(comp.node);

uuid

组件的 uuid，用于编辑器。

示例

cc.log(comp.uuid);

_enabled

enabled

表示该组件自身是否启用。

示例

comp.enabled = true;
cc.log(comp.enabled);

enabledInHierarchy

表示该组件是否被启用并且所在的节点也处于激活状态。

示例

cc.log(comp.enabledInHierarchy);

_isOnLoadCalled

返回一个值用来判断 onLoad 是否被调用过，不等于 0 时调用过，等于 0 时未调用。

示例

cc.log(this._isOnLoadCalled > 0);

_name

_objFlags

name

该对象的名称。

示例

obj.name = "New Obj";

isValid

表示该对象是否可用（被 destroy 后将不可用）。当一个对象的 destroy 调用以后，会在这一帧结束后才真正销毁。因此从下一帧开始 isValid 就会返回 false，而当前帧内 isValid 仍然会是 true。如果希望判断当前帧是否调用过 destroy，请使用 cc.isValid(obj, true)，不过这往往是特殊的业务需求引起的，通常情况下不需要这样。

示例

var node = new cc.Node();
cc.log(node.isValid);    // true
node.destroy();
cc.log(node.isValid);    // true, still valid in this frame
// after a frame...
cc.log(node.isValid);    // false, destroyed in the end of last frame

方法

updateAlignment

立刻执行 widget 对齐操作。这个接口一般不需要手工调用。只有当你需要在当前帧结束前获得 widget 对齐后的最新结果时才需要手动调用这个方法。

示例

widget.top = 10;       // change top margin
cc.log(widget.node.y); // not yet changed
widget.updateAlignment();
cc.log(widget.node.y); // changed

update

如果该组件启用，则每帧调用 update。该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

参数列表

• dt Number the delta time in seconds it took to complete the last frame

lateUpdate

如果该组件启用，则每帧调用 LateUpdate。该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

__preload

__preload is called before every onLoad.It is used to initialize the builtin components internally,to avoid checking whether onLoad is called before every public method calls.This method should be removed if script priority is supported.

onLoad

当附加到一个激活的节点上或者其节点第一次激活时候调用。onLoad 总是会在任何 start 方法调用前执行，这能用于安排脚本的初始化顺序。该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

start

如果该组件第一次启用，则在所有组件的 update 之前调用。通常用于需要在所有组件的 onLoad 初始化完毕后执行的逻辑。该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

onEnable

当该组件被启用，并且它的节点也激活时。该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

onDisable

当该组件被禁用或节点变为无效时调用。该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

onDestroy

当该组件被销毁时调用该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

onFocusInEditor

onLostFocusInEditor

resetInEditor

用来初始化组件或节点的一些属性，当该组件被第一次添加到节点上或用户点击了它的 Reset 菜单时调用。这个回调只会在编辑器下调用。

addComponent

向节点添加一个组件类，你还可以通过传入脚本的名称来添加组件。

参数列表

• typeOrClassName Function | String the constructor or the class name of the component to add

示例

var sprite = node.addComponent(cc.Sprite);
var test = node.addComponent("Test");

getComponent

获取节点上指定类型的组件，如果节点有附加指定类型的组件，则返回，如果没有则为空。传入参数也可以是脚本的名称。

参数列表

• typeOrClassName Function | String

示例

// get sprite component.
var sprite = node.getComponent(cc.Sprite);
// get custom test calss.
var test = node.getComponent("Test");

getComponents

返回节点上指定类型的所有组件。

参数列表

• typeOrClassName Function | String

示例

var sprites = node.getComponents(cc.Sprite);
var tests = node.getComponents("Test");

getComponentInChildren

递归查找所有子节点中第一个匹配指定类型的组件。

参数列表

• typeOrClassName Function | String

示例

var sprite = node.getComponentInChildren(cc.Sprite);
var Test = node.getComponentInChildren("Test");

getComponentsInChildren

递归查找自身或所有子节点中指定类型的组件

参数列表

• typeOrClassName Function | String

示例

var sprites = node.getComponentsInChildren(cc.Sprite);
var tests = node.getComponentsInChildren("Test");

_getLocalBounds

如果组件的包围盒与节点不同，您可以实现该方法以提供自定义的轴向对齐的包围盒（AABB），以便编辑器的场景视图可以正确地执行点选测试。

参数列表

• out_rect Rect the Rect to receive the bounding box

onRestore

onRestore 是用户在检查器菜单点击 Reset 时，对此组件执行撤消操作后调用的。如果组件包含了“内部状态”（不在 CCClass 属性中定义的临时成员变量），那么你可能需要实现该方法。编辑器执行撤销/重做操作时，将调用组件的 get set 来录制和还原组件的状态。然而，在极端的情况下，它可能无法良好运作。那么你就应该实现这个方法，手动根据组件的属性同步“内部状态”。一旦你实现这个方法，当用户撤销或重做时，组件的所有 get set 都不会再被调用。这意味着仅仅指定了默认值的属性将被编辑器记录和还原。同样的，编辑可能无法在极端情况下正确地重置您的组件。于是如果你需要支持组件重置菜单，你需要在该方法中手工同步组件属性到“内部状态”。一旦你实现这个方法，组件的所有 get set 都不会在重置操作时被调用。这意味着仅仅指定了默认值的属性将被编辑器重置。此方法仅在编辑器下会被调用。

schedule

调度一个自定义的回调函数。如果回调函数已调度，那么将不会重复调度它，只会更新时间间隔参数。

参数列表

• callback function The callback function
• interval Number Tick interval in seconds. 0 means tick every frame.
• repeat Number The selector will be executed (repeat + 1) times, you can use cc.macro.REPEAT_FOREVER for tick infinitely.
• delay Number The amount of time that the first tick will wait before execution.

示例

var timeCallback = function (dt) {
  cc.log("time: " + dt);
}
this.schedule(timeCallback, 1);

scheduleOnce

调度一个只运行一次的回调函数，可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。

参数列表

• callback function A function wrapped as a selector
• delay Number The amount of time that the first tick will wait before execution.

示例

var timeCallback = function (dt) {
  cc.log("time: " + dt);
}
this.scheduleOnce(timeCallback, 2);

unschedule

取消调度一个自定义的回调函数。

参数列表

• callback_fn function A function wrapped as a selector

示例

this.unschedule(_callback);

unscheduleAllCallbacks

取消调度所有已调度的回调函数：定制的回调函数以及 'update' 回调函数。动作不受此方法影响。

示例

this.unscheduleAllCallbacks();

destroy

销毁该对象，并释放所有它对其它对象的引用。实际销毁操作会延迟到当前帧渲染前执行。从下一帧开始，该对象将不再可用。您可以在访问对象之前使用 cc.isValid(obj) 来检查对象是否已被销毁。

示例

obj.destroy();

_destruct

Clear all references in the instance.

NOTE: this method will not clear the getter or setter functions which defined in the instance of CCObject. You can override the _destruct method if you need, for example: _destruct: function () { for (var key in this) { if (this.hasOwnProperty(key)) { switch (typeof this[key]) { case 'string': this[key] = ''; break; case 'object': case 'function': this[key] = null; break; } } }

_onPreDestroy

Called before the object being destroyed.

_serialize

The customized serialization for this object. (Editor Only)

参数列表

• exporting Boolean

_deserialize

Init this object from the custom serialized data.

参数列表

• data Object the serialized json data
• ctx _Deserializer