UIListViewTest_Vertical类 参考

#include <UIListViewTest.h>

类 UIListViewTest_Vertical 继承关系图:

UIListViewTest_Vertical 的协作图:

Public 成员函数
	CREATE_FUNC (UIListViewTest_Vertical)
	UIListViewTest_Vertical ()
	~UIListViewTest_Vertical ()
virtual bool	init () override
void	selectedItemEvent (cocos2d::Ref *sender, cocos2d::ui::ListView::EventType type)
void	selectedItemEventScrollView (cocos2d::Ref *sender, cocos2d::ui::ScrollView::EventType type)
virtual void	update (float dt) override
Public 成员函数 继承自 UIScene
	UIScene ()
	~UIScene ()
virtual void	onEnter () override
Public 成员函数 继承自 TestCase
	TestCase ()
	~TestCase ()
virtual std::string	title () const
virtual std::string	subtitle () const
virtual Type	getTestType () const
virtual float	getDuration () const
virtual std::string	getExpectedOutput () const
virtual std::string	getActualOutput () const
virtual void	restartTestCallback (cocos2d::Ref *sender)
virtual void	nextTestCallback (cocos2d::Ref *sender)
virtual void	priorTestCallback (cocos2d::Ref *sender)
virtual void	onBackCallback (cocos2d::Ref *sender)
void	setTestSuite (TestSuite *testSuite)
TestSuite *	getTestSuite () const
float	getRunTime () const
void	setTestCaseName (const std::string &name)
std::string	getTestCaseName () const
const cocos2d::Label *	getSubtitleLable () const
const cocos2d::MenuItemImage *	getRestartTestItem () const

Protected 成员函数
float	getItemPositionYInView (cocos2d::ui::Widget *item) const
void	updateItem (int itemID, int templateID)

Protected 属性
cocos2d::ui::Text *	_displayValueLabel = nullptr
int	_spawnCount = 5
int	_totalCount = 50
float	_bufferZone = 45.f
float	_itemTemplateHeight = 0.f
float	_updateInterval = (1.0f / 24)
float	_updateTimer = 0.f
float	_lastContentPosY = 0.f
float	_reuseItemOffset = 0.f
cocos2d::ui::ListView *	_listView =nullptr
std::vector< std::string >	_array
cocos2d::ui::Text *	_indexLabels [3] = {nullptr}
Protected 属性 继承自 UIScene
cocos2d::Layer *	_uiLayer
cocos2d::ui::Layout *	_widget
cocos2d::ui::Text *	_sceneTitle
Protected 属性 继承自 TestCase
cocos2d::MenuItemImage *	_priorTestItem
cocos2d::MenuItemImage *	_restartTestItem
cocos2d::MenuItemImage *	_nextTestItem
cocos2d::Label *	_titleLabel
cocos2d::Label *	_subtitleLabel

额外继承的成员函数
Public 类型 继承自 TestCase
enum class	Type { ROBUSTNESS , UNIT , GRAPHICAL_STATIC , MANUAL }
Public 属性 继承自 TestCase
CC_CONSTRUCTOR_ACCESS	__pad0__: virtual bool init() override

详细描述

在文件 UIListViewTest.h 第 34 行定义.

构造及析构函数说明

UIListViewTest_Vertical()

UIListViewTest_Vertical::UIListViewTest_Vertical

(

)

在文件 UIListViewTest.cpp 第 48 行定义.

{
}

~UIListViewTest_Vertical()

UIListViewTest_Vertical::~UIListViewTest_Vertical

(

)

在文件 UIListViewTest.cpp 第 52 行定义.

{
}

成员函数说明

CREATE_FUNC()

UIListViewTest_Vertical::CREATE_FUNC

(

UIListViewTest_Vertical

)

getItemPositionYInView()

float UIListViewTest_Vertical::getItemPositionYInView ( cocos2d::ui::Widget *  item ) const

protected

在文件 UIListViewTest.cpp 第 199 行定义.

{
    auto worldPos = item->getParent()->convertToWorldSpaceAR(item->getPosition());
    auto viewPos = this->_listView->convertToNodeSpaceAR(worldPos);
    return viewPos.y;
}

引用了 _listView.

被这些函数引用 update().

这是这个函数的调用关系图:

init()

bool UIListViewTest_Vertical::init ( )

overridevirtual

重载 UIScene .

在文件 UIListViewTest.cpp 第 56 行定义.

{
    if (UIScene::init())
    {
        Size widgetSize = _widget->getContentSize();
        
        _displayValueLabel = Text::create("There are 50 items, but we only create 5 templates", "fonts/Marker Felt.ttf", 20);
        _displayValueLabel->setAnchorPoint(Vec2(0.5f, -1.0f));
        _displayValueLabel->setPosition(Vec2(widgetSize.width / 2.0f,
                                              widgetSize.height / 2.0f + _displayValueLabel->getContentSize().height * 1.5f + 30));
        _uiLayer->addChild(_displayValueLabel);
        
        
        Text* alert = Text::create("ListView vertical", "fonts/Marker Felt.ttf", 30);
        alert->setColor(Color3B(159, 168, 176));
        alert->setPosition(Vec2(widgetSize.width / 2.0f,
                                 widgetSize.height / 2.0f - alert->getContentSize().height * 3.075f));
        _uiLayer->addChild(alert);
        
        Layout* root = static_cast<Layout*>(_uiLayer->getChildByTag(81));
        
        Layout* background = dynamic_cast<Layout*>(root->getChildByName("background_Panel"));
        Size backgroundSize = background->getContentSize();
        
        
        // create list view ex data
       
        for (int i = 0; i < _totalCount; ++i)
        {
            std::string ccstr = StringUtils::format("listview_item_%d", i);
            _array.push_back(ccstr);
        }
        
        
        // Create the list view ex
        _listView = ListView::create();
        // set list view ex direction
        _listView->setDirection(ui::ScrollView::Direction::VERTICAL);
        _listView->setBounceEnabled(true);
        _listView->setBackGroundImage("cocosui/green_edit.png");
        _listView->setGlobalZOrder(200);
        _listView->setBackGroundImageScale9Enabled(true);
        _listView->setContentSize(Size(240.0f, 130.0f));
        _listView->setPosition(Vec2((widgetSize - _listView->getContentSize()) / 2.0f));
        _listView->addEventListener((ui::ListView::ccListViewCallback)CC_CALLBACK_2(UIListViewTest_Vertical::selectedItemEvent, this));
        _listView->addEventListener((ui::ListView::ccScrollViewCallback)CC_CALLBACK_2(UIListViewTest_Vertical::selectedItemEventScrollView,this));
        _listView->setScrollBarPositionFromCorner(Vec2(7, 7));
        _uiLayer->addChild(_listView);
        
        
        // create model
        Button* default_button = Button::create("cocosui/backtotoppressed.png", "cocosui/backtotopnormal.png");
        default_button->setName("Title Button");
        
        Layout* default_item = Layout::create();
        default_item->setTouchEnabled(true);
        default_item->setContentSize(default_button->getContentSize());
        default_button->setPosition(Vec2(default_item->getContentSize() / 2.0f));
        default_item->addChild(default_button);
        
        auto clippingNode = ClippingNode::create();
        auto sprite = Sprite::create("cocosui/clippingHead.jpg");
        clippingNode->addChild(sprite);
        auto stencil = Sprite::create("cocosui/clippingStencil.jpg");
        clippingNode->setStencil(stencil);
        auto custom_item_contentSize = default_item->getContentSize();
        clippingNode->setPosition(sprite->getContentSize().width/2,
                                  custom_item_contentSize.height/2);
        clippingNode->setScale(0.5);
        default_item->addChild(clippingNode);
        
        // set model
        _listView->setItemModel(default_item);
        
        // set all items layout gravity
        _listView->setGravity(ListView::Gravity::CENTER_VERTICAL);
        
        //initial the data
        for (int i = 0; i < _totalCount; ++i) {
            if (i < _spawnCount) {
                Widget* item = default_item->clone();
                item->setTag(i);
                Button* btn = (Button*)item->getChildByName("Title Button");
                btn->setTitleText(_array.at(i));
                _listView->pushBackCustomItem(item);
            }
        }
        
        // set items margin
        float spacing = 4;
        _listView->setItemsMargin(spacing);
        _itemTemplateHeight = default_item->getContentSize().height;
        this->_reuseItemOffset = (_itemTemplateHeight + spacing) * _spawnCount;
 
        //update listview data
        this->scheduleUpdate();
        
        _listView->forceDoLayout();
        float totalHeight = _itemTemplateHeight * _totalCount + (_totalCount - 1) * spacing;
        _listView->setInnerContainerSize(Size(_listView->getInnerContainerSize().width, totalHeight));
        _listView->jumpToTop();
        
 
        // Show the indexes of items on each boundary.
        {
            float position = 75;
            // Labels
            _indexLabels[0] = Text::create(" ", "fonts/Marker Felt.ttf", 12);
            _indexLabels[0]->setAnchorPoint(Vec2::ANCHOR_MIDDLE);
            _indexLabels[0]->setPosition(_uiLayer->getContentSize() / 2 + Size(0.0f, position));
            _uiLayer->addChild(_indexLabels[0]);
            _indexLabels[1] = Text::create("  ", "fonts/Marker Felt.ttf", 12);
            _indexLabels[1]->setAnchorPoint(Vec2::ANCHOR_MIDDLE);
            _indexLabels[1]->setPosition(_uiLayer->getContentSize() / 2 + Size(140.0f, 0.0f));
            _uiLayer->addChild(_indexLabels[1]);
            _indexLabels[2] = Text::create(" ", "fonts/Marker Felt.ttf", 12);
            _indexLabels[2]->setAnchorPoint(Vec2::ANCHOR_MIDDLE);
            _indexLabels[2]->setPosition(_uiLayer->getContentSize() / 2 + Size(0.0f, -position));
            _uiLayer->addChild(_indexLabels[2]);
            
            // Callback
            _listView->ScrollView::addEventListener([this](Ref* ref, ScrollView::EventType eventType) {
                ListView* listView = dynamic_cast<ListView*>(ref);
                if(listView == nullptr || eventType != ScrollView::EventType::CONTAINER_MOVED)
                {
                    return;
                }
                auto bottom = listView->getBottommostItemInCurrentView();
                auto center = listView->getCenterItemInCurrentView();
                auto top = listView->getTopmostItemInCurrentView();
                
                _indexLabels[0]->setString(StringUtils::format("Top index=%zd", listView->getIndex(top)));
                _indexLabels[1]->setString(StringUtils::format("Center\nindex=%zd", listView->getIndex(center)));
                _indexLabels[2]->setString(StringUtils::format("Bottom index=%zd", listView->getIndex(bottom)));
            });
        }
 
        return true;
    }
    
    return false;
}

引用了 _array, _displayValueLabel, _indexLabels, _itemTemplateHeight, _listView, _reuseItemOffset, _spawnCount, _totalCount, UIScene::_uiLayer, UIScene::_widget, UIScene::init(), selectedItemEvent() , 以及 selectedItemEventScrollView().

函数调用图:

selectedItemEvent()

void UIListViewTest_Vertical::selectedItemEvent	(	cocos2d::Ref *	sender,
		cocos2d::ui::ListView::EventType	type
	)

在文件 UIListViewTest.cpp 第 256 行定义.

{
    switch (type)
    {
        case cocos2d::ui::ListView::EventType::ON_SELECTED_ITEM_START:
        {
            ListView* listView = static_cast<ListView*>(pSender);
            auto item = listView->getItem(listView->getCurSelectedIndex());
            log("select child start index = %d", item->getTag());
            break;
        }
        case cocos2d::ui::ListView::EventType::ON_SELECTED_ITEM_END:
        {
            ListView* listView = static_cast<ListView*>(pSender);
            auto item = listView->getItem(listView->getCurSelectedIndex());
            log("select child end index = %d", item->getTag());
            break;
        }
        default:
            break;
    }
}

被这些函数引用 init().

这是这个函数的调用关系图:

selectedItemEventScrollView()

void UIListViewTest_Vertical::selectedItemEventScrollView	(	cocos2d::Ref *	sender,
		cocos2d::ui::ScrollView::EventType	type
	)

在文件 UIListViewTest.cpp 第 279 行定义.

{
    switch (type) {
        case ui::ScrollView::EventType::SCROLL_TO_BOTTOM:
            CCLOG("SCROLL_TO_BOTTOM");
            break;
        case ui::ScrollView::EventType::SCROLL_TO_TOP:
            CCLOG("SCROLL_TO_TOP");
            break;
        default:
            break;
    }
}

被这些函数引用 init().

这是这个函数的调用关系图:

update()

void UIListViewTest_Vertical::update ( float  dt )

overridevirtual

在文件 UIListViewTest.cpp 第 215 行定义.

{
    this->_updateTimer += dt;
    if (this->_updateTimer < this->_updateInterval) {
        return;
    }
 
    float totalHeight = _itemTemplateHeight * _totalCount + (_totalCount - 1) * 4;
 
    auto listViewHeight = _listView->getContentSize().height;
    
    this->_updateTimer = 0;
    auto isDown = this->_listView->getInnerContainerPosition().y < this->_lastContentPosY;
    auto items = _listView->getItems();
    
    for (int i = 0; i < _spawnCount && i < _totalCount; ++i) {
        auto item = items.at(i);
        auto itemPos = this->getItemPositionYInView(item);
        if (isDown) {
            if (itemPos < -_bufferZone && item->getPosition().y + _reuseItemOffset < totalHeight) {
                int itemID = item->getTag() - (int)items.size();
                item->setPositionY(item->getPositionY() + _reuseItemOffset);
                CCLOG("itemPos = %f, itemID = %d, templateID = %d", itemPos, itemID, i);
                this->updateItem(itemID, i);
            }
        }
        else {
            if (itemPos > _bufferZone + listViewHeight &&
                item->getPosition().y - _reuseItemOffset >= 0) {
                
                item->setPositionY(item->getPositionY() - _reuseItemOffset);
                int itemID = item->getTag() + (int)items.size();
                CCLOG("itemPos = %f, itemID = %d, templateID = %d", itemPos, itemID, i);
                this->updateItem(itemID, i);
            }
        }
    }
    //update ListView Items
    this->_lastContentPosY = this->_listView->getInnerContainer()->getPosition().y;
}

引用了 _bufferZone, _itemTemplateHeight, _lastContentPosY, _listView, _reuseItemOffset, _spawnCount, _totalCount, _updateInterval, _updateTimer, getItemPositionYInView() , 以及 updateItem().

函数调用图:

updateItem()

void UIListViewTest_Vertical::updateItem ( int  itemID, int  templateID  )

protected

在文件 UIListViewTest.cpp 第 206 行定义.

{
    auto itemTemplate = _listView->getItems().at(templateID);
    Button* btn = (Button*)itemTemplate->getChildByName("Title Button");
    //If you have  the item ID and templateID, you could fill in the data here
    itemTemplate->setTag(itemID);
    btn->setTitleText(_array.at(itemID));
}

引用了 _array , 以及 _listView.

被这些函数引用 update().

这是这个函数的调用关系图:

类成员变量说明

_array

std::vector<std::string> UIListViewTest_Vertical::_array

protected

在文件 UIListViewTest.h 第 68 行定义.

被这些函数引用 init() , 以及 updateItem().

_bufferZone

float UIListViewTest_Vertical::_bufferZone = 45.f

protected

在文件 UIListViewTest.h 第 59 行定义.

被这些函数引用 update().

_displayValueLabel

cocos2d::ui::Text* UIListViewTest_Vertical::_displayValueLabel = nullptr

protected

在文件 UIListViewTest.h 第 51 行定义.

被这些函数引用 init().

_indexLabels

cocos2d::ui::Text* UIListViewTest_Vertical::_indexLabels[3] = {nullptr}

protected

在文件 UIListViewTest.h 第 69 行定义.

被这些函数引用 init().

_itemTemplateHeight

float UIListViewTest_Vertical::_itemTemplateHeight = 0.f

protected

在文件 UIListViewTest.h 第 60 行定义.

被这些函数引用 init() , 以及 update().

_lastContentPosY

float UIListViewTest_Vertical::_lastContentPosY = 0.f

protected

在文件 UIListViewTest.h 第 65 行定义.

被这些函数引用 update().

_listView

cocos2d::ui::ListView* UIListViewTest_Vertical::_listView =nullptr

protected

在文件 UIListViewTest.h 第 67 行定义.

被这些函数引用 getItemPositionYInView(), init(), update() , 以及 updateItem().

_reuseItemOffset

float UIListViewTest_Vertical::_reuseItemOffset = 0.f

protected

在文件 UIListViewTest.h 第 66 行定义.

被这些函数引用 init() , 以及 update().

_spawnCount

int UIListViewTest_Vertical::_spawnCount = 5

protected

在文件 UIListViewTest.h 第 54 行定义.

被这些函数引用 init() , 以及 update().

_totalCount

int UIListViewTest_Vertical::_totalCount = 50

protected

在文件 UIListViewTest.h 第 56 行定义.

被这些函数引用 init() , 以及 update().

_updateInterval

float UIListViewTest_Vertical::_updateInterval = (1.0f / 24)

protected

在文件 UIListViewTest.h 第 62 行定义.

被这些函数引用 update().

_updateTimer

float UIListViewTest_Vertical::_updateTimer = 0.f

protected

在文件 UIListViewTest.h 第 63 行定义.

被这些函数引用 update().

---

该类的文档由以下文件生成:

• /Users/yujizhu/Documents/Git/cocos2d-x-4.0/tests/cpp-tests/Classes/UITest/CocoStudioGUITest/UIListViewTest/UIListViewTest.h
• /Users/yujizhu/Documents/Git/cocos2d-x-4.0/tests/cpp-tests/Classes/UITest/CocoStudioGUITest/UIListViewTest/UIListViewTest.cpp