mirror of
https://github.com/cocos/cocos4.git
synced 2026-11-20 23:52:40 +08:00
606 lines
18 KiB
JavaScript
606 lines
18 KiB
JavaScript
/****************************************************************************
|
|
Copyright (c) 2011-2012 cocos2d-x.org
|
|
Copyright (c) 2013-2014 Chukong Technologies Inc.
|
|
|
|
http://www.cocos2d-x.org
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
all copies or substantial portions of the Software.
|
|
|
|
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.
|
|
****************************************************************************/
|
|
|
|
/**
|
|
* The list view control of Cocos UI.
|
|
* @class
|
|
* @extends ccui.ScrollView
|
|
* @example
|
|
* var listView = new ccui.ListView();
|
|
* // set list view ex direction
|
|
* listView.setDirection(ccui.ScrollView.Dir.VERTICAL);
|
|
* listView.setTouchEnabled(true);
|
|
* listView.setBounceEnabled(true);
|
|
* listView.setBackGroundImage("res/cocosui/green_edit.png");
|
|
* listView.setBackGroundImageScale9Enabled(true);
|
|
* listView.setContentSize(cc.size(240, 130));
|
|
* this.addChild(listView);
|
|
*/
|
|
ccui.ListView = ccui.ScrollView.extend(/** @lends ccui.ListView# */{
|
|
_model: null,
|
|
_items: null,
|
|
_gravity: null,
|
|
_itemsMargin: 0,
|
|
|
|
_curSelectedIndex: 0,
|
|
_refreshViewDirty: true,
|
|
|
|
_listViewEventListener: null,
|
|
_listViewEventSelector: null,
|
|
/**
|
|
* allocates and initializes a UIListView.
|
|
* Constructor of ccui.ListView, override it to extend the construction behavior, remember to call "this._super()" in the extended "ctor" function.
|
|
* @example
|
|
* // example
|
|
* var aListView = new ccui.ListView();
|
|
*/
|
|
ctor: function () {
|
|
ccui.ScrollView.prototype.ctor.call(this);
|
|
this._items = [];
|
|
this._gravity = ccui.ListView.GRAVITY_CENTER_VERTICAL;
|
|
this.setTouchEnabled(true);
|
|
|
|
this.init();
|
|
},
|
|
|
|
/**
|
|
* Initializes a ccui.ListView. Please do not call this function by yourself, you should pass the parameters to constructor to initialize it.
|
|
* @returns {boolean}
|
|
* @override
|
|
*/
|
|
init: function () {
|
|
if (ccui.ScrollView.prototype.init.call(this)) {
|
|
this.setLayoutType(ccui.Layout.Type.LINEAR_VERTICAL);
|
|
return true;
|
|
}
|
|
return false;
|
|
},
|
|
|
|
/**
|
|
* Sets a item model for ListView. A model will be cloned for adding default item.
|
|
* @param {ccui.Widget} model
|
|
*/
|
|
setItemModel: function (model) {
|
|
if (!model){
|
|
cc.log("Can't set a null to item model!");
|
|
return;
|
|
}
|
|
|
|
this._model = model;
|
|
},
|
|
|
|
_updateInnerContainerSize: function () {
|
|
var locItems = this._items, length, i;
|
|
switch (this.direction) {
|
|
case ccui.ScrollView.Dir.VERTICAL:
|
|
length = locItems.length;
|
|
var totalHeight = (length - 1) * this._itemsMargin;
|
|
for (i = 0; i < length; i++) {
|
|
totalHeight += locItems[i].getContentSize().height;
|
|
}
|
|
this.setInnerContainerSize(cc.size(this._contentSize.width, totalHeight));
|
|
break;
|
|
case ccui.ScrollView.Dir.HORIZONTAL:
|
|
length = locItems.length;
|
|
var totalWidth = (length - 1) * this._itemsMargin;
|
|
for (i = 0; i < length; i++) {
|
|
totalWidth += locItems[i].getContentSize().width;
|
|
}
|
|
this.setInnerContainerSize(cc.size(totalWidth, this._contentSize.height));
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
},
|
|
|
|
_remedyLayoutParameter: function (item) {
|
|
cc.assert(null != item, "ListView Item can't be nil!");
|
|
|
|
var linearLayoutParameter = item.getLayoutParameter();
|
|
var isLayoutParameterExists = true;
|
|
if (!linearLayoutParameter) {
|
|
linearLayoutParameter = new ccui.LinearLayoutParameter();
|
|
isLayoutParameterExists = false;
|
|
}
|
|
var itemIndex = this.getIndex(item);
|
|
switch (this.direction) {
|
|
case ccui.ScrollView.Dir.VERTICAL:
|
|
this._remedyVerticalLayoutParameter(linearLayoutParameter, itemIndex);
|
|
break;
|
|
case ccui.ScrollView.Dir.HORIZONTAL:
|
|
this._remedyHorizontalLayoutParameter(linearLayoutParameter, itemIndex);
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
if (!isLayoutParameterExists)
|
|
item.setLayoutParameter(linearLayoutParameter);
|
|
},
|
|
|
|
//@since v3.3
|
|
_remedyVerticalLayoutParameter: function (layoutParameter, itemIndex) {
|
|
cc.assert(null != layoutParameter, "Layout parameter can't be nil!");
|
|
|
|
switch (this._gravity) {
|
|
case ccui.ListView.GRAVITY_LEFT:
|
|
layoutParameter.setGravity(ccui.LinearLayoutParameter.LEFT);
|
|
break;
|
|
case ccui.ListView.GRAVITY_RIGHT:
|
|
layoutParameter.setGravity(ccui.LinearLayoutParameter.RIGHT);
|
|
break;
|
|
case ccui.ListView.GRAVITY_CENTER_HORIZONTAL:
|
|
layoutParameter.setGravity(ccui.LinearLayoutParameter.CENTER_HORIZONTAL);
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
if (0 === itemIndex)
|
|
layoutParameter.setMargin(ccui.MarginZero());
|
|
else
|
|
layoutParameter.setMargin(new ccui.Margin(0.0, this._itemsMargin, 0.0, 0.0));
|
|
},
|
|
|
|
//@since v3.3
|
|
_remedyHorizontalLayoutParameter: function (layoutParameter, itemIndex) {
|
|
cc.assert(null != layoutParameter, "Layout parameter can't be nil!");
|
|
|
|
switch (this._gravity) {
|
|
case ccui.ListView.GRAVITY_TOP:
|
|
layoutParameter.setGravity(ccui.LinearLayoutParameter.TOP);
|
|
break;
|
|
case ccui.ListView.GRAVITY_BOTTOM:
|
|
layoutParameter.setGravity(ccui.LinearLayoutParameter.BOTTOM);
|
|
break;
|
|
case ccui.ListView.GRAVITY_CENTER_VERTICAL:
|
|
layoutParameter.setGravity(ccui.LinearLayoutParameter.CENTER_VERTICAL);
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
if (0 === itemIndex)
|
|
layoutParameter.setMargin(ccui.MarginZero());
|
|
else
|
|
layoutParameter.setMargin(new ccui.Margin(this._itemsMargin, 0.0, 0.0, 0.0));
|
|
},
|
|
|
|
/**
|
|
* Push back a default item(create by a cloned model) into ListView.
|
|
*/
|
|
pushBackDefaultItem: function () {
|
|
if (this._model == null)
|
|
return;
|
|
var newItem = this._model.clone();
|
|
this._remedyLayoutParameter(newItem);
|
|
this.addChild(newItem);
|
|
this._refreshViewDirty = true;
|
|
},
|
|
|
|
/**
|
|
* Insert a default item(create by a cloned model) into ListView.
|
|
* @param {Number} index
|
|
*/
|
|
insertDefaultItem: function (index) {
|
|
if (this._model == null)
|
|
return;
|
|
var newItem = this._model.clone();
|
|
this._items.splice(index, 0, newItem);
|
|
ccui.ScrollView.prototype.addChild.call(this, newItem);
|
|
this._remedyLayoutParameter(newItem);
|
|
|
|
this._refreshViewDirty = true;
|
|
},
|
|
|
|
/**
|
|
* Push back custom item into ListView.
|
|
* @param {ccui.Widget} item
|
|
*/
|
|
pushBackCustomItem: function (item) {
|
|
this._remedyLayoutParameter(item);
|
|
this.addChild(item);
|
|
this._refreshViewDirty = true;
|
|
},
|
|
|
|
/**
|
|
* add child to ListView
|
|
* @override
|
|
* @param {_ccsg.Node} widget
|
|
* @param {Number} [zOrder]
|
|
* @param {Number|String} [tag] tag or name
|
|
*/
|
|
addChild: function (widget, zOrder, tag) {
|
|
if (widget) {
|
|
zOrder = zOrder || widget.getLocalZOrder();
|
|
tag = tag || widget.getName();
|
|
ccui.ScrollView.prototype.addChild.call(this, widget, zOrder, tag);
|
|
if(widget instanceof ccui.Widget)
|
|
this._items.push(widget);
|
|
}
|
|
},
|
|
|
|
/**
|
|
* remove child from ListView
|
|
* @override
|
|
* @param {_ccsg.Node} widget
|
|
* @param {Boolean} [cleanup=true]
|
|
*/
|
|
removeChild: function(widget, cleanup){
|
|
if (widget) {
|
|
var index = this._items.indexOf(widget);
|
|
if(index > -1)
|
|
this._items.splice(index, 1);
|
|
ccui.ScrollView.prototype.removeChild.call(this, widget, cleanup);
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Removes all children from ccui.ListView.
|
|
*/
|
|
removeAllChildren: function(){
|
|
this.removeAllChildrenWithCleanup(true);
|
|
},
|
|
|
|
/**
|
|
* Removes all children from ccui.ListView and do a cleanup all running actions depending on the cleanup parameter.
|
|
* @param {Boolean} cleanup
|
|
*/
|
|
removeAllChildrenWithCleanup: function(cleanup){
|
|
ccui.ScrollView.prototype.removeAllChildrenWithCleanup.call(this, cleanup);
|
|
this._items = [];
|
|
},
|
|
|
|
/**
|
|
* Push back custom item into ccui.ListView.
|
|
* @param {ccui.Widget} item
|
|
* @param {Number} index
|
|
*/
|
|
insertCustomItem: function (item, index) {
|
|
this._items.splice(index, 0, item);
|
|
ccui.ScrollView.prototype.addChild.call(this, item);
|
|
this._remedyLayoutParameter(item);
|
|
this._refreshViewDirty = true;
|
|
},
|
|
|
|
/**
|
|
* Removes a item whose index is same as the parameter.
|
|
* @param {Number} index
|
|
*/
|
|
removeItem: function (index) {
|
|
var item = this.getItem(index);
|
|
if (item == null)
|
|
return;
|
|
this.removeChild(item, true);
|
|
this._refreshViewDirty = true;
|
|
},
|
|
|
|
/**
|
|
* Removes the last item of ccui.ListView.
|
|
*/
|
|
removeLastItem: function () {
|
|
this.removeItem(this._items.length - 1);
|
|
},
|
|
|
|
/**
|
|
* Removes all items from ccui.ListView.
|
|
*/
|
|
removeAllItems: function(){
|
|
this.removeAllChildren();
|
|
},
|
|
|
|
/**
|
|
* Returns a item whose index is same as the parameter.
|
|
* @param {Number} index
|
|
* @returns {ccui.Widget}
|
|
*/
|
|
getItem: function (index) {
|
|
if (index < 0 || index >= this._items.length)
|
|
return null;
|
|
return this._items[index];
|
|
},
|
|
|
|
/**
|
|
* Returns the item container.
|
|
* @returns {Array}
|
|
*/
|
|
getItems: function () {
|
|
return this._items;
|
|
},
|
|
|
|
/**
|
|
* Returns the index of item.
|
|
* @param {ccui.Widget} item the item which need to be checked.
|
|
* @returns {Number} the index of item.
|
|
*/
|
|
getIndex: function (item) {
|
|
if(item == null)
|
|
return -1;
|
|
return this._items.indexOf(item);
|
|
},
|
|
|
|
/**
|
|
* Changes the gravity of ListView.
|
|
* @param {ccui.ListView.GRAVITY_LEFT|ccui.ListView.GRAVITY_RIGHT|ccui.ListView.GRAVITY_CENTER_HORIZONTAL|ccui.ListView.GRAVITY_BOTTOM|ccui.ListView.GRAVITY_CENTER_VERTICAL} gravity
|
|
*/
|
|
setGravity: function (gravity) {
|
|
if (this._gravity === gravity)
|
|
return;
|
|
this._gravity = gravity;
|
|
this._refreshViewDirty = true;
|
|
},
|
|
|
|
/**
|
|
* Changes the margin between each item.
|
|
* @param {Number} margin
|
|
*/
|
|
setItemsMargin: function (margin) {
|
|
if (this._itemsMargin === margin)
|
|
return;
|
|
this._itemsMargin = margin;
|
|
this._refreshViewDirty = true;
|
|
},
|
|
|
|
/**
|
|
* Returns the margin between each item.
|
|
* @returns {Number}
|
|
*/
|
|
getItemsMargin:function(){
|
|
return this._itemsMargin;
|
|
},
|
|
|
|
/**
|
|
* Changes scroll direction of ccui.ListView.
|
|
* @param {ccui.ScrollView.Dir} dir
|
|
*/
|
|
setDirection: function (dir) {
|
|
switch (dir) {
|
|
case ccui.ScrollView.Dir.VERTICAL:
|
|
this.setLayoutType(ccui.Layout.Type.LINEAR_VERTICAL);
|
|
break;
|
|
case ccui.ScrollView.Dir.HORIZONTAL:
|
|
this.setLayoutType(ccui.Layout.Type.LINEAR_HORIZONTAL);
|
|
break;
|
|
case ccui.ScrollView.Dir.BOTH:
|
|
return;
|
|
default:
|
|
return;
|
|
break;
|
|
}
|
|
ccui.ScrollView.prototype.setDirection.call(this, dir);
|
|
},
|
|
|
|
/**
|
|
* Requests refresh list view.
|
|
*/
|
|
requestRefreshView: function () {
|
|
this._refreshViewDirty = true;
|
|
},
|
|
|
|
/**
|
|
* Refreshes list view.
|
|
*/
|
|
refreshView: function () {
|
|
var locItems = this._items;
|
|
for (var i = 0; i < locItems.length; i++) {
|
|
var item = locItems[i];
|
|
item.setLocalZOrder(i);
|
|
this._remedyLayoutParameter(item);
|
|
}
|
|
this._updateInnerContainerSize();
|
|
},
|
|
|
|
/**
|
|
* provides a public _doLayout function for Editor. it calls _doLayout.
|
|
*/
|
|
doLayout: function(){
|
|
this._doLayout();
|
|
},
|
|
|
|
_doLayout: function(){
|
|
ccui.Layout.prototype._doLayout.call(this);
|
|
if (this._refreshViewDirty) {
|
|
this.refreshView();
|
|
this._refreshViewDirty = false;
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Adds event listener to ccui.ListView.
|
|
* @param {Function} selector
|
|
* @param {Object} [target=]
|
|
* @deprecated since v3.0, please use addEventListener instead.
|
|
*/
|
|
addEventListenerListView: function (selector, target) {
|
|
this.addEventListener(selector, target);
|
|
},
|
|
|
|
/**
|
|
* Adds event listener to ccui.ListView.
|
|
* @param {Function} selector
|
|
* @param {Object} [target=]
|
|
*/
|
|
addEventListener: function(selector, target){
|
|
this._listViewEventListener = target;
|
|
this._listViewEventSelector = selector;
|
|
},
|
|
|
|
_selectedItemEvent: function (event) {
|
|
var eventEnum = (event === ccui.Widget.TOUCH_BEGAN) ? ccui.ListView.ON_SELECTED_ITEM_START : ccui.ListView.ON_SELECTED_ITEM_END;
|
|
if(this._listViewEventSelector){
|
|
if (this._listViewEventListener)
|
|
this._listViewEventSelector.call(this._listViewEventListener, this, eventEnum);
|
|
else
|
|
this._listViewEventSelector(this, eventEnum);
|
|
}
|
|
if(this._ccEventCallback)
|
|
this._ccEventCallback(this, eventEnum);
|
|
},
|
|
|
|
/**
|
|
* Intercept touch event, handle its child's touch event.
|
|
* @param {cc.Event} event
|
|
*/
|
|
interceptTouchEvent: function (event) {
|
|
var eventType = event._widgetEventType,
|
|
touch = event.currentTouch,
|
|
parent;
|
|
ccui.ScrollView.prototype.interceptTouchEvent.call(this, event);
|
|
if (!this._touchEnabled)
|
|
return;
|
|
|
|
if (eventType !== ccui.Widget.TOUCH_MOVED) {
|
|
parent = event.target;
|
|
while (parent) {
|
|
if (parent && parent.getParent() === this._innerContainer) {
|
|
this._curSelectedIndex = this.getIndex(parent);
|
|
break;
|
|
}
|
|
parent = parent.getParent();
|
|
}
|
|
if (event.target.isHighlighted())
|
|
this._selectedItemEvent(eventType);
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Returns current selected index
|
|
* @returns {number}
|
|
*/
|
|
getCurSelectedIndex: function () {
|
|
return this._curSelectedIndex;
|
|
},
|
|
|
|
_onSizeChanged: function () {
|
|
ccui.ScrollView.prototype._onSizeChanged.call(this);
|
|
this._refreshViewDirty = true;
|
|
},
|
|
|
|
/**
|
|
* Returns the "class name" of ccui.ListView.
|
|
* @returns {string}
|
|
*/
|
|
getDescription: function () {
|
|
return "ListView";
|
|
},
|
|
|
|
_createCloneInstance: function () {
|
|
return new ccui.ListView();
|
|
},
|
|
|
|
_copyClonedWidgetChildren: function (model) {
|
|
var arrayItems = model.getItems();
|
|
for (var i = 0; i < arrayItems.length; i++) {
|
|
var item = arrayItems[i];
|
|
this.pushBackCustomItem(item.clone());
|
|
}
|
|
},
|
|
|
|
_copySpecialProperties: function (listView) {
|
|
if(listView instanceof ccui.ListView){
|
|
ccui.ScrollView.prototype._copySpecialProperties.call(this, listView);
|
|
this.setItemModel(listView._model);
|
|
this.setItemsMargin(listView._itemsMargin);
|
|
this.setGravity(listView._gravity);
|
|
|
|
this._listViewEventListener = listView._listViewEventListener;
|
|
this._listViewEventSelector = listView._listViewEventSelector;
|
|
}
|
|
},
|
|
|
|
//v3.3
|
|
forceDoLayout: function(){
|
|
if (this._refreshViewDirty) {
|
|
this.refreshView();
|
|
this._refreshViewDirty = false;
|
|
}
|
|
this._innerContainer.forceDoLayout();
|
|
}
|
|
});
|
|
|
|
/**
|
|
* allocates and initializes a UIListView.
|
|
* @deprecated since v3.0, please use new ccui.ListView() instead.
|
|
*/
|
|
ccui.ListView.create = function () {
|
|
return new ccui.ListView();
|
|
};
|
|
|
|
// Constants
|
|
//listView event type
|
|
/**
|
|
* The flag selected item of ccui.ListView's event.
|
|
* @constant
|
|
* @type {number}
|
|
*/
|
|
ccui.ListView.EVENT_SELECTED_ITEM = 0;
|
|
|
|
/**
|
|
* The flag selected item start of ccui.ListView's event.
|
|
* @constant
|
|
* @type {number}
|
|
*/
|
|
ccui.ListView.ON_SELECTED_ITEM_START = 0;
|
|
/**
|
|
* The flag selected item end of ccui.ListView's event.
|
|
* @constant
|
|
* @type {number}
|
|
*/
|
|
ccui.ListView.ON_SELECTED_ITEM_END = 1;
|
|
|
|
//listView gravity
|
|
/**
|
|
* The left flag of ccui.ListView's gravity.
|
|
* @constant
|
|
* @type {number}
|
|
*/
|
|
ccui.ListView.GRAVITY_LEFT = 0;
|
|
/**
|
|
* The right flag of ccui.ListView's gravity.
|
|
* @constant
|
|
* @type {number}
|
|
*/
|
|
ccui.ListView.GRAVITY_RIGHT = 1;
|
|
/**
|
|
* The center horizontal flag of ccui.ListView's gravity.
|
|
* @constant
|
|
* @type {number}
|
|
*/
|
|
ccui.ListView.GRAVITY_CENTER_HORIZONTAL = 2;
|
|
/**
|
|
* The top flag of ccui.ListView's gravity.
|
|
* @constant
|
|
* @type {number}
|
|
*/
|
|
ccui.ListView.GRAVITY_TOP = 3;
|
|
/**
|
|
* The bottom flag of ccui.ListView's gravity.
|
|
* @constant
|
|
* @type {number}
|
|
*/
|
|
ccui.ListView.GRAVITY_BOTTOM = 4;
|
|
/**
|
|
* The center vertical flag of ccui.ListView's gravity.
|
|
* @constant
|
|
* @type {number}
|
|
*/
|
|
ccui.ListView.GRAVITY_CENTER_VERTICAL = 5; |