mirror of
https://github.com/cocos/cocos4.git
synced 2026-11-20 23:52:40 +08:00
502 lines
16 KiB
JavaScript
502 lines
16 KiB
JavaScript
/****************************************************************************
|
||
Copyright (c) 2013-2016 Chukong Technologies Inc.
|
||
|
||
http://www.cocos.com
|
||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||
of this software and associated engine source code (the "Software"), a limited,
|
||
worldwide, royalty-free, non-assignable, revocable and non-exclusive license
|
||
to use Cocos Creator solely to develop games on your target platforms. You shall
|
||
not use Cocos Creator software for developing other software or tools that's
|
||
used for developing games. You are not granted to publish, distribute,
|
||
sublicense, and/or sell copies of Cocos Creator.
|
||
|
||
The software or tools in this License Agreement are licensed, not sold.
|
||
Chukong Aipu reserves all rights not expressly granted to you.
|
||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||
THE SOFTWARE.
|
||
****************************************************************************/
|
||
|
||
// Mask for AlignFlags
|
||
var TOP = 1 << 0;
|
||
var MID = 1 << 1; // vertical center
|
||
var BOT = 1 << 2;
|
||
var LEFT = 1 << 3;
|
||
var CENTER = 1 << 4; // horizontal center
|
||
var RIGHT = 1 << 5;
|
||
var TOP_BOT = TOP | BOT;
|
||
var LEFT_RIGHT = LEFT | RIGHT;
|
||
|
||
/**
|
||
* !#en
|
||
* Stores and manipulate the anchoring based on its parent.
|
||
* Widget are used for GUI but can also be used for other things.
|
||
* !#zh
|
||
* Widget 组件,用于设置和适配其相对于父节点的边距,Widget 通常被用于 UI 界面,也可以用于其他地方。
|
||
* @class Widget
|
||
* @extends Component
|
||
*/
|
||
var Widget = cc.Class({
|
||
name: 'cc.Widget', extends: require('./CCComponent'),
|
||
|
||
editor: CC_EDITOR && {
|
||
menu: 'i18n:MAIN_MENU.component.ui/Widget',
|
||
help: 'app://docs/html/components/widget.html',
|
||
inspector: 'app://editor/page/inspector/widget/index.html',
|
||
executeInEditMode: true,
|
||
disallowMultiple: true,
|
||
},
|
||
|
||
properties: {
|
||
|
||
// ENABLE ALIGN ?
|
||
|
||
/**
|
||
* !#en Whether to align the top.
|
||
* !#zh 是否对齐上边。
|
||
* @property isAlignTop
|
||
* @type {Boolean}
|
||
* @default false
|
||
*/
|
||
isAlignTop: {
|
||
get: function () {
|
||
return (this._alignFlags & TOP) > 0;
|
||
},
|
||
set: function (value) {
|
||
this._setAlign(TOP, value);
|
||
},
|
||
animatable: false,
|
||
tooltip: 'i18n:COMPONENT.widget.align_top',
|
||
},
|
||
|
||
/**
|
||
* !#en
|
||
* Vertically aligns the midpoint, This will open the other vertical alignment options cancel.
|
||
* !#zh
|
||
* 是否垂直方向对齐中点,开启此项会将垂直方向其他对齐选项取消。
|
||
* @property isAlignVerticalCenter
|
||
* @type {Boolean}
|
||
* @default false
|
||
*/
|
||
isAlignVerticalCenter: {
|
||
get: function () {
|
||
return (this._alignFlags & MID) > 0;
|
||
},
|
||
set: function (value) {
|
||
if (value) {
|
||
this.isAlignTop = false;
|
||
this.isAlignBottom = false;
|
||
this._alignFlags |= MID;
|
||
}
|
||
else {
|
||
this._alignFlags &= ~MID;
|
||
}
|
||
},
|
||
animatable: false,
|
||
tooltip: 'i18n:COMPONENT.widget.align_v_center',
|
||
},
|
||
|
||
/**
|
||
* !#en Whether to align the bottom.
|
||
* !#zh 是否对齐下边。
|
||
* @property isAlignBottom
|
||
* @type {Boolean}
|
||
* @default false
|
||
*/
|
||
isAlignBottom: {
|
||
get: function () {
|
||
return (this._alignFlags & BOT) > 0;
|
||
},
|
||
set: function (value) {
|
||
this._setAlign(BOT, value);
|
||
},
|
||
animatable: false,
|
||
tooltip: 'i18n:COMPONENT.widget.align_bottom',
|
||
},
|
||
|
||
/**
|
||
* !#en Whether to align the left.
|
||
* !#zh 是否对齐左边
|
||
* @property isAlignLeft
|
||
* @type {Boolean}
|
||
* @default false
|
||
*/
|
||
isAlignLeft: {
|
||
get: function () {
|
||
return (this._alignFlags & LEFT) > 0;
|
||
},
|
||
set: function (value) {
|
||
this._setAlign(LEFT, value);
|
||
},
|
||
animatable: false,
|
||
tooltip: 'i18n:COMPONENT.widget.align_left',
|
||
},
|
||
|
||
/**
|
||
* !#en
|
||
* Horizontal aligns the midpoint. This will open the other horizontal alignment options canceled.
|
||
* !#zh
|
||
* 是否水平方向对齐中点,开启此选项会将水平方向其他对齐选项取消。
|
||
* @property isAlignHorizontalCenter
|
||
* @type {Boolean}
|
||
* @default false
|
||
*/
|
||
isAlignHorizontalCenter: {
|
||
get: function () {
|
||
return (this._alignFlags & CENTER) > 0;
|
||
},
|
||
set: function (value) {
|
||
if (value) {
|
||
this.isAlignLeft = false;
|
||
this.isAlignRight = false;
|
||
this._alignFlags |= CENTER;
|
||
}
|
||
else {
|
||
this._alignFlags &= ~CENTER;
|
||
}
|
||
},
|
||
animatable: false,
|
||
tooltip: 'i18n:COMPONENT.widget.align_h_center',
|
||
},
|
||
|
||
/**
|
||
* !#en Whether to align the right.
|
||
* !#zh 是否对齐右边。
|
||
* @property isAlignRight
|
||
* @type {Boolean}
|
||
* @default false
|
||
*/
|
||
isAlignRight: {
|
||
get: function () {
|
||
return (this._alignFlags & RIGHT) > 0;
|
||
},
|
||
set: function (value) {
|
||
this._setAlign(RIGHT, value);
|
||
},
|
||
animatable: false,
|
||
tooltip: 'i18n:COMPONENT.widget.align_right',
|
||
},
|
||
|
||
/**
|
||
* !#en
|
||
* Whether the stretched horizontally, when enable the left and right alignment will be stretched horizontally,
|
||
* the width setting is invalid (read only).
|
||
* !#zh
|
||
* 当前是否水平拉伸。当同时启用左右对齐时,节点将会被水平拉伸,此时节点的宽度只读。
|
||
* @property isStretchWidth
|
||
* @type {Boolean}
|
||
* @default false
|
||
* @readOnly
|
||
*/
|
||
isStretchWidth: {
|
||
get: function () {
|
||
return (this._alignFlags & LEFT_RIGHT) === LEFT_RIGHT;
|
||
},
|
||
visible: false
|
||
},
|
||
/**
|
||
* !#en
|
||
* Whether the stretched vertically, when enable the left and right alignment will be stretched vertically,
|
||
* then height setting is invalid (read only)
|
||
* !#zh
|
||
* 当前是否垂直拉伸。当同时启用上下对齐时,节点将会被垂直拉伸,此时节点的高度只读。
|
||
* @property isStretchHeight
|
||
* @type {Boolean}
|
||
* @default false
|
||
* @readOnly
|
||
*/
|
||
isStretchHeight: {
|
||
get: function () {
|
||
return (this._alignFlags & TOP_BOT) === TOP_BOT;
|
||
},
|
||
visible: false
|
||
},
|
||
|
||
// ALIGN MARGINS
|
||
|
||
/**
|
||
* !#en
|
||
* The margins between the top of this node and the top of parent node,
|
||
* the value can be negative, Only available in 'isAlignTop' open.
|
||
* !#zh
|
||
* 本节点顶边和父节点顶边的距离,可填写负值,只有在 isAlignTop 开启时才有作用。
|
||
* @property top
|
||
* @type {Number}
|
||
* @default 0
|
||
*/
|
||
top: {
|
||
get: function () {
|
||
return this._top;
|
||
},
|
||
set: function (value) {
|
||
this._top = value;
|
||
},
|
||
tooltip: 'i18n:COMPONENT.widget.top',
|
||
},
|
||
|
||
/**
|
||
* !#en
|
||
* The margins between the bottom of this node and the bottom of parent node,
|
||
* the value can be negative, Only available in 'isAlignBottom' open.
|
||
* !#zh
|
||
* 本节点底边和父节点底边的距离,可填写负值,只有在 isAlignBottom 开启时才有作用。
|
||
* @property bottom
|
||
* @type {Number}
|
||
* @default 0
|
||
*/
|
||
bottom: {
|
||
get: function () {
|
||
return this._bottom;
|
||
},
|
||
set: function (value) {
|
||
this._bottom = value;
|
||
},
|
||
tooltip: 'i18n:COMPONENT.widget.bottom',
|
||
},
|
||
|
||
/**
|
||
* !#en
|
||
* The margins between the left of this node and the left of parent node,
|
||
* the value can be negative, Only available in 'isAlignLeft' open.
|
||
* !#zh
|
||
* 本节点左边和父节点左边的距离,可填写负值,只有在 isAlignLeft 开启时才有作用。
|
||
* @property left
|
||
* @type {Number}
|
||
* @default 0
|
||
*/
|
||
left: {
|
||
get: function () {
|
||
return this._left;
|
||
},
|
||
set: function (value) {
|
||
this._left = value;
|
||
},
|
||
tooltip: 'i18n:COMPONENT.widget.left',
|
||
},
|
||
|
||
/**
|
||
* !#en
|
||
* The margins between the right of this node and the right of parent node,
|
||
* the value can be negative, Only available in 'isAlignRight' open.
|
||
* !#zh
|
||
* 本节点右边和父节点右边的距离,可填写负值,只有在 isAlignRight 开启时才有作用。
|
||
* @property right
|
||
* @type {Number}
|
||
* @default 0
|
||
*/
|
||
right: {
|
||
get: function () {
|
||
return this._right;
|
||
},
|
||
set: function (value) {
|
||
this._right = value;
|
||
},
|
||
tooltip: 'i18n:COMPONENT.widget.right',
|
||
},
|
||
|
||
// PARCENTAGE OR ABSOLUTE
|
||
|
||
/**
|
||
* !#en
|
||
* If true, top is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's height.
|
||
* !#zh
|
||
* 如果为 true,"top" 将会以像素作为边距,否则将会以相对父物体高度的百分比(0 到 1)作为边距。
|
||
* @property isAbsoluteTop
|
||
* @type {Boolean}
|
||
* @default true
|
||
*/
|
||
isAbsoluteTop: {
|
||
get: function () {
|
||
return this._isAbsTop;
|
||
},
|
||
set: function (value) {
|
||
this._isAbsTop = value;
|
||
},
|
||
animatable: false
|
||
},
|
||
|
||
/**
|
||
* !#en
|
||
* If true, bottom is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's height.
|
||
* !#zh
|
||
* 如果为 true,"bottom" 将会以像素作为边距,否则将会以相对父物体高度的百分比(0 到 1)作为边距。
|
||
* @property isAbsoluteBottom
|
||
* @type {Boolean}
|
||
* @default true
|
||
*/
|
||
isAbsoluteBottom: {
|
||
get: function () {
|
||
return this._isAbsBottom;
|
||
},
|
||
set: function (value) {
|
||
this._isAbsBottom = value;
|
||
},
|
||
animatable: false
|
||
},
|
||
|
||
/**
|
||
* !#en
|
||
* If true, left is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's width.
|
||
* !#zh
|
||
* 如果为 true,"left" 将会以像素作为边距,否则将会以相对父物体宽度的百分比(0 到 1)作为边距。
|
||
* @property isAbsoluteLeft
|
||
* @type {Boolean}
|
||
* @default true
|
||
*/
|
||
isAbsoluteLeft: {
|
||
get: function () {
|
||
return this._isAbsLeft;
|
||
},
|
||
set: function (value) {
|
||
this._isAbsLeft = value;
|
||
},
|
||
animatable: false
|
||
},
|
||
|
||
/**
|
||
* !#en
|
||
* If true, right is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's width.
|
||
* !#zh
|
||
* 如果为 true,"right" 将会以像素作为边距,否则将会以相对父物体宽度的百分比(0 到 1)作为边距。
|
||
* @property isAbsoluteRight
|
||
* @type {Boolean}
|
||
* @default true
|
||
*/
|
||
isAbsoluteRight: {
|
||
get: function () {
|
||
return this._isAbsRight;
|
||
},
|
||
set: function (value) {
|
||
this._isAbsRight = value;
|
||
},
|
||
animatable: false
|
||
},
|
||
|
||
/**
|
||
* !#en TODO
|
||
* !#zh
|
||
* 开启后仅会在 onEnable 的当帧结束时对齐一次,然后立刻禁用当前组件。
|
||
* 这样便于脚本或动画继续控制当前节点。
|
||
* 注意:onEnable 时所在的那一帧仍然会进行对齐。
|
||
* @property isAlignOnce
|
||
* @type {Boolean}
|
||
* @default false
|
||
*/
|
||
isAlignOnce: {
|
||
default: false,
|
||
tooltip: 'i18n:COMPONENT.widget.align_once',
|
||
displayName: "AlignOnce"
|
||
},
|
||
|
||
//
|
||
|
||
/**
|
||
* !#zh: 对齐开关,由 AlignFlags 组成
|
||
*
|
||
* @property _alignFlags
|
||
* @type {Number}
|
||
* @default 0
|
||
* @private
|
||
*/
|
||
_alignFlags: 0,
|
||
|
||
_left: 0,
|
||
_right: 0,
|
||
_top: 0,
|
||
_bottom: 0,
|
||
_isAbsLeft: true,
|
||
_isAbsRight: true,
|
||
_isAbsTop: true,
|
||
_isAbsBottom: true,
|
||
|
||
// original size before align
|
||
_originalWidth: 0,
|
||
_originalHeight: 0
|
||
},
|
||
|
||
onEnable: function () {
|
||
cc._widgetManager.add(this);
|
||
},
|
||
|
||
onDisable: function () {
|
||
cc._widgetManager.remove(this);
|
||
},
|
||
|
||
_setAlign: function (flag, isAlign) {
|
||
var current = (this._alignFlags & flag) > 0;
|
||
if (isAlign == current) {
|
||
return;
|
||
}
|
||
var isHorizontal = (flag & LEFT_RIGHT) > 0;
|
||
if (isAlign) {
|
||
this._alignFlags |= flag;
|
||
|
||
if (isHorizontal) {
|
||
this.isAlignHorizontalCenter = false;
|
||
if (this.isStretchWidth) {
|
||
// become stretch
|
||
this._originalWidth = this.node.width;
|
||
// test check conflict
|
||
if (CC_EDITOR && !cc.engine.isPlaying) {
|
||
_Scene.DetectConflict.checkConflict_Widget(this);
|
||
}
|
||
}
|
||
}
|
||
else {
|
||
this.isAlignVerticalCenter = false;
|
||
if (this.isStretchHeight) {
|
||
// become stretch
|
||
this._originalHeight = this.node.height;
|
||
// test check conflict
|
||
if (CC_EDITOR && !cc.engine.isPlaying) {
|
||
_Scene.DetectConflict.checkConflict_Widget(this);
|
||
}
|
||
}
|
||
}
|
||
|
||
if (CC_EDITOR && !cc.engine._isPlaying && this.node._parent) {
|
||
// adjust the offsets to keep the size and position unchanged after alignment chagned
|
||
var type;
|
||
if (flag & TOP) {
|
||
type = 'top';
|
||
}
|
||
else if (flag & LEFT) {
|
||
type = 'left';
|
||
}
|
||
else if (flag & RIGHT) {
|
||
type = 'right';
|
||
}
|
||
else if (flag & BOT) {
|
||
type = 'bottom';
|
||
}
|
||
cc._widgetManager.updateOffsetsToStayPut(this, type);
|
||
}
|
||
}
|
||
else {
|
||
if (isHorizontal) {
|
||
if (this.isStretchWidth) {
|
||
// will cancel stretch
|
||
this.node.width = this._originalWidth;
|
||
}
|
||
}
|
||
else {
|
||
if (this.isStretchHeight) {
|
||
// will cancel stretch
|
||
this.node.height = this._originalHeight;
|
||
}
|
||
}
|
||
|
||
this._alignFlags &= ~flag;
|
||
}
|
||
}
|
||
});
|
||
|
||
|
||
cc.Widget = module.exports = Widget;
|