PageView Class

Extends ScrollView

Module: cc

The PageView control

Index

Properties
  • sizeMode PageView.SizeMode Specify the size type of each page in PageView.
  • direction PageView.Direction The page view direction
  • scrollThreshold Number The scroll threshold value, when drag exceeds this value, release the next page will automatically scroll, less than the restore
  • autoPageTurningThreshold Number Auto page turning velocity threshold. When users swipe the PageView quickly, it will calculate a velocity based on the scroll distance and time, if the calculated velocity is larger than the threshold, then it will trigger page turning.
  • pageTurningEventTiming Number Change the PageTurning event timing of PageView.
  • indicator PageViewIndicator The Page View Indicator
  • pageTurningSpeed Number The time required to turn over a page. unit: second
  • pageEvents Component.EventHandler[] PageView events callback
  • content Node This is a reference to the UI element to be scrolled.
  • horizontal Boolean Enable horizontal scroll.
  • vertical Boolean Enable vertical scroll.
  • inertia Boolean When inertia is set, the content will continue to move when touch ended.
  • brake Number It determines how quickly the content stop moving. A value of 1 will stop the movement immediately. A value of 0 will never stop the movement until it reaches to the boundary of scrollview.
  • elastic Boolean When elastic is set, the content will be bounce back when move out of boundary.
  • bounceDuration Number The elapse time of bouncing back. A value of 0 will bounce back immediately.
  • horizontalScrollBar Scrollbar The horizontal scrollbar reference.
  • verticalScrollBar Scrollbar The vertical scrollbar reference.
  • scrollEvents Component.EventHandler[] Scrollview events callback
  • cancelInnerEvents Boolean If cancelInnerEvents is set to true, the scroll behavior will cancel touch events on inner content nodes It's set to true by default.
  • __eventTargets Array Register all related EventTargets, all event callbacks will be removed in _onPreDestroy
  • node Node The node this component is attached to. A component is always attached to a node.
  • uuid String The uuid for editor.
  • _enabled Boolean
  • enabled Boolean indicates whether this component is enabled or not.
  • enabledInHierarchy Boolean indicates whether this component is enabled and its node is also active in the hierarchy.
  • _isOnLoadCalled Number Returns a value which used to indicate the onLoad get called or not.
  • _name String
  • _objFlags Number
  • name String The name of the object.
  • isValid Boolean Indicates whether the object is not yet destroyed.
Methods
  • getCurrentPageIndex Returns current page index
  • setCurrentPageIndex Set current page index
  • getPages Returns all pages of pageview
  • addPage At the end of the current page view to insert a new view
  • insertPage Inserts a page in the specified location
  • removePage Removes a page from PageView.
  • removePageAtIndex Removes a page at index of PageView.
  • removeAllPages Removes all pages from PageView
  • scrollToPage Scroll PageView to index.
  • scrollToBottom Scroll the content to the bottom boundary of ScrollView.
  • scrollToTop Scroll the content to the top boundary of ScrollView.
  • scrollToLeft Scroll the content to the left boundary of ScrollView.
  • scrollToRight Scroll the content to the right boundary of ScrollView.
  • scrollToTopLeft Scroll the content to the top left boundary of ScrollView.
  • scrollToTopRight Scroll the content to the top right boundary of ScrollView.
  • scrollToBottomLeft Scroll the content to the bottom left boundary of ScrollView.
  • scrollToBottomRight Scroll the content to the bottom right boundary of ScrollView.
  • scrollToOffset Scroll with an offset related to the ScrollView's top left origin, if timeInSecond is omitted, then it will jump to the specific offset immediately.
  • getScrollOffset Get the positive offset value corresponds to the content's top left boundary.
  • getMaxScrollOffset Get the maximize available scroll offset
  • scrollToPercentHorizontal Scroll the content to the horizontal percent position of ScrollView.
  • scrollTo Scroll the content to the percent position of ScrollView in any direction.
  • scrollToPercentVertical Scroll the content to the vertical percent position of ScrollView.
  • stopAutoScroll Stop auto scroll immediately
  • setContentPosition Modify the content position.
  • getContentPosition Query the content's position in its parent space.
  • isScrolling Query whether the user is currently dragging the ScrollView to scroll it
  • isAutoScrolling Query whether the ScrollView is currently scrolling because of a bounceback or inertia slowdown.
  • update Update is called every frame, if the Component is enabled.
  • lateUpdate LateUpdate is called every frame, if the Component is enabled.
  • __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 When attaching to an active node or its node first activated. onLoad is always called before any start functions, this allows you to order initialization of scripts.
  • start Called before all scripts' update if the Component is enabled the first time. Usually used to initialize some logic which need to be called after all components' onload methods called.
  • onEnable Called when this component becomes enabled and its node is active.
  • onDisable Called when this component becomes disabled or its node becomes inactive.
  • onDestroy Called when this component will be destroyed.
  • onFocusInEditor
  • onLostFocusInEditor
  • resetInEditor Called to initialize the component or node’s properties when adding the component the first time or when the Reset command is used. This function is only called in editor.
  • addComponent Adds a component class to the node. You can also add component to node by passing in the name of the script.
  • getComponent Returns the component of supplied type if the node has one attached, null if it doesn't.
    You can also get component in the node by passing in the name of the script.
  • getComponents Returns all components of supplied Type in the node.
  • getComponentInChildren Returns the component of supplied type in any of its children using depth first search.
  • getComponentsInChildren Returns the components of supplied type in self or any of its children using depth first search.
  • _getLocalBounds If the component's bounding box is different from the node's, you can implement this method to supply a custom axis aligned bounding box (AABB), so the editor's scene view can perform hit test properly.
  • onRestore onRestore is called after the user clicks the Reset item in the Inspector's context menu or performs an undo operation on this component.

    If the component contains the "internal state", short for "temporary member variables which not included
    in its CCClass properties", then you may need to implement this function.

    The editor will call the getset accessors of your component to record/restore the component's state
    for undo/redo operation. However, in extreme cases, it may not works well. Then you should implement
    this function to manually synchronize your component's "internal states" with its public properties.
    Once you implement this function, all the getset accessors of your component will not be called when
    the user performs an undo/redo operation. Which means that only the properties with default value
    will be recorded or restored by editor.

    Similarly, the editor may failed to reset your component correctly in extreme cases. Then if you need
    to support the reset menu, you should manually synchronize your component's "internal states" with its
    properties in this function. Once you implement this function, all the getset accessors of your component
    will not be called during reset operation. Which means that only the properties with default value
    will be reset by editor.

This function is only called in editor mode.

  • schedule Schedules a custom selector.
    If the selector is already scheduled, then the interval parameter will be updated without scheduling it again.
  • scheduleOnce Schedules a callback function that runs only once, with a delay of 0 or larger.
  • unschedule Unschedules a custom callback function.
  • unscheduleAllCallbacks unschedule all scheduled callback functions: custom callback functions, and the 'update' callback function.
    Actions are not affected by this method.
  • destroy Destroy this Object, and release all its own references to other objects.
    Actual object destruction will delayed until before rendering.
    After destroy, this CCObject is not usable any more. You can use cc.isValid(obj) to check whether the object is destroyed before accessing it.
  • _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)
  • _deserialize Init this object from the custom serialized data.
Events
  • page-turning Note: This event is emitted from the node to which the component belongs.
  • scroll-to-top Note: This event is emitted from the node to which the component belongs.
  • scroll-to-bottom Note: This event is emitted from the node to which the component belongs.
  • scroll-to-left Note: This event is emitted from the node to which the component belongs.
  • scroll-to-right Note: This event is emitted from the node to which the component belongs.
  • scrolling Note: This event is emitted from the node to which the component belongs.
  • bounce-bottom Note: This event is emitted from the node to which the component belongs.
  • bounce-top Note: This event is emitted from the node to which the component belongs.
  • bounce-left Note: This event is emitted from the node to which the component belongs.
  • bounce-right Note: This event is emitted from the node to which the component belongs.
  • scroll-ended Note: This event is emitted from the node to which the component belongs.
  • touch-up Note: This event is emitted from the node to which the component belongs.
  • scroll-began Note: This event is emitted from the node to which the component belongs.

Details

Properties

sizeMode

Specify the size type of each page in PageView.

meta description
Type PageView.SizeMode
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCPageView.js:111
direction

The page view direction

meta description
Type PageView.Direction
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCPageView.js:125
scrollThreshold

The scroll threshold value, when drag exceeds this value, release the next page will automatically scroll, less than the restore

meta description
Type Number
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCPageView.js:139
autoPageTurningThreshold

Auto page turning velocity threshold. When users swipe the PageView quickly, it will calculate a velocity based on the scroll distance and time, if the calculated velocity is larger than the threshold, then it will trigger page turning.

meta description
Type Number
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCPageView.js:154
pageTurningEventTiming

Change the PageTurning event timing of PageView.

meta description
Type Number
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCPageView.js:171
indicator

The Page View Indicator

meta description
Type PageViewIndicator
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCPageView.js:183
pageTurningSpeed

The time required to turn over a page. unit: second

meta description
Type Number
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCPageView.js:199
pageEvents

PageView events callback

meta description
Type Component.EventHandler[]
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCPageView.js:210
content

This is a reference to the UI element to be scrolled.

meta description
Type Node
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:200
horizontal

Enable horizontal scroll.

meta description
Type Boolean
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:211
vertical

Enable vertical scroll.

meta description
Type Boolean
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:222
inertia

When inertia is set, the content will continue to move when touch ended.

meta description
Type Boolean
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:233
brake

It determines how quickly the content stop moving. A value of 1 will stop the movement immediately. A value of 0 will never stop the movement until it reaches to the boundary of scrollview.

meta description
Type Number
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:243
elastic

When elastic is set, the content will be bounce back when move out of boundary.

meta description
Type Boolean
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:258
bounceDuration

The elapse time of bouncing back. A value of 0 will bounce back immediately.

meta description
Type Number
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:269
horizontalScrollBar

The horizontal scrollbar reference.

meta description
Type Scrollbar
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:280
verticalScrollBar

The vertical scrollbar reference.

meta description
Type Scrollbar
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:298
scrollEvents

Scrollview events callback

meta description
Type Component.EventHandler[]
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:316
cancelInnerEvents

If cancelInnerEvents is set to true, the scroll behavior will cancel touch events on inner content nodes It's set to true by default.

meta description
Type Boolean
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:327
__eventTargets

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

meta description
Type Array
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:61
node

The node this component is attached to. A component is always attached to a node.

meta description
Type Node
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:75
Examples
cc.log(comp.node);
uuid

The uuid for editor.

meta description
Type String
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:111
Examples
cc.log(comp.uuid);
_enabled
meta description
Type Boolean
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:159
enabled

indicates whether this component is enabled or not.

meta description
Type Boolean
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:166
Examples
comp.enabled = true;
cc.log(comp.enabled);
enabledInHierarchy

indicates whether this component is enabled and its node is also active in the hierarchy.

meta description
Type Boolean
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:197
Examples
cc.log(comp.enabledInHierarchy);
_isOnLoadCalled

Returns a value which used to indicate the onLoad get called or not.

meta description
Type Number
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:213
Examples
cc.log(this._isOnLoadCalled > 0);
_name
meta description
Type String
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/platform/CCObject.js:50
_objFlags
meta description
Type Number
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/platform/CCObject.js:57
name

The name of the object.

meta description
Type String
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/platform/CCObject.js:208
Examples
obj.name = "New Obj";
isValid

Indicates whether the object is not yet destroyed.

meta description
Type Boolean
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/platform/CCObject.js:225
Examples
cc.log(obj.isValid);

Methods

getCurrentPageIndex

Returns current page index

meta description
Returns Number
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCPageView.js:257
setCurrentPageIndex

Set current page index

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCPageView.js:267
Parameters
getPages

Returns all pages of pageview

meta description
Returns Node[]
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCPageView.js:277
addPage

At the end of the current page view to insert a new view

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCPageView.js:287
Parameters
insertPage

Inserts a page in the specified location

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCPageView.js:301
Parameters
removePage

Removes a page from PageView.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCPageView.js:321
Parameters
removePageAtIndex

Removes a page at index of PageView.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCPageView.js:337
Parameters
removeAllPages

Removes all pages from PageView

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCPageView.js:353
scrollToPage

Scroll PageView to index.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCPageView.js:367
Parameters
  • idx Number index of page.
  • timeInSecond Number scrolling time
scrollToBottom

Scroll the content to the bottom boundary of ScrollView.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:345
Parameters
  • timeInSecond Number Scroll time in second, if you don't pass timeInSecond, the content will jump to the bottom boundary immediately.
  • attenuated Boolean Whether the scroll acceleration attenuated, default is true.
Examples
// Scroll to the bottom of the view.
scrollView.scrollToBottom(0.1);
scrollToTop

Scroll the content to the top boundary of ScrollView.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:370
Parameters
  • timeInSecond Number Scroll time in second, if you don't pass timeInSecond, the content will jump to the top boundary immediately.
  • attenuated Boolean Whether the scroll acceleration attenuated, default is true.
Examples
// Scroll to the top of the view.
scrollView.scrollToTop(0.1);
scrollToLeft

Scroll the content to the left boundary of ScrollView.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:395
Parameters
  • timeInSecond Number Scroll time in second, if you don't pass timeInSecond, the content will jump to the left boundary immediately.
  • attenuated Boolean Whether the scroll acceleration attenuated, default is true.
Examples
// Scroll to the left of the view.
scrollView.scrollToLeft(0.1);
scrollToRight

Scroll the content to the right boundary of ScrollView.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:420
Parameters
  • timeInSecond Number Scroll time in second, if you don't pass timeInSecond, the content will jump to the right boundary immediately.
  • attenuated Boolean Whether the scroll acceleration attenuated, default is true.
Examples
// Scroll to the right of the view.
scrollView.scrollToRight(0.1);
scrollToTopLeft

Scroll the content to the top left boundary of ScrollView.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:445
Parameters
  • timeInSecond Number Scroll time in second, if you don't pass timeInSecond, the content will jump to the top left boundary immediately.
  • attenuated Boolean Whether the scroll acceleration attenuated, default is true.
Examples
// Scroll to the upper left corner of the view.
scrollView.scrollToTopLeft(0.1);
scrollToTopRight

Scroll the content to the top right boundary of ScrollView.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:470
Parameters
  • timeInSecond Number Scroll time in second, if you don't pass timeInSecond, the content will jump to the top right boundary immediately.
  • attenuated Boolean Whether the scroll acceleration attenuated, default is true.
Examples
// Scroll to the top right corner of the view.
scrollView.scrollToTopRight(0.1);
scrollToBottomLeft

Scroll the content to the bottom left boundary of ScrollView.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:495
Parameters
  • timeInSecond Number Scroll time in second, if you don't pass timeInSecond, the content will jump to the bottom left boundary immediately.
  • attenuated Boolean Whether the scroll acceleration attenuated, default is true.
Examples
// Scroll to the lower left corner of the view.
scrollView.scrollToBottomLeft(0.1);
scrollToBottomRight

Scroll the content to the bottom right boundary of ScrollView.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:520
Parameters
  • timeInSecond Number Scroll time in second, if you don't pass timeInSecond, the content will jump to the bottom right boundary immediately.
  • attenuated Boolean Whether the scroll acceleration attenuated, default is true.
Examples
// Scroll to the lower right corner of the view.
scrollView.scrollToBottomRight(0.1);
scrollToOffset

Scroll with an offset related to the ScrollView's top left origin, if timeInSecond is omitted, then it will jump to the specific offset immediately.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:546
Parameters
  • offset Vec2 A Vec2, the value of which each axis between 0 and maxScrollOffset
  • timeInSecond Number Scroll time in second, if you don't pass timeInSecond, the content will jump to the specific offset of ScrollView immediately.
  • attenuated Boolean Whether the scroll acceleration attenuated, default is true.
Examples
// Scroll to middle position in 0.1 second in x-axis
var maxScrollOffset = this.getMaxScrollOffset();
scrollView.scrollToOffset(cc.p(maxScrollOffset.x / 2, 0), 0.1);
getScrollOffset

Get the positive offset value corresponds to the content's top left boundary.

meta description
Returns Vec2
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:580
getMaxScrollOffset

Get the maximize available scroll offset

meta description
Returns Vec2
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:593
scrollToPercentHorizontal

Scroll the content to the horizontal percent position of ScrollView.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:610
Parameters
  • percent Number A value between 0 and 1.
  • timeInSecond Number Scroll time in second, if you don't pass timeInSecond, the content will jump to the horizontal percent position of ScrollView immediately.
  • attenuated Boolean Whether the scroll acceleration attenuated, default is true.
Examples
// Scroll to middle position.
scrollView.scrollToBottomRight(0.5, 0.1);
scrollTo

Scroll the content to the percent position of ScrollView in any direction.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:636
Parameters
  • anchor Vec2 A point which will be clamp between cc.p(0,0) and cc.p(1,1).
  • timeInSecond Number Scroll time in second, if you don't pass timeInSecond, the content will jump to the percent position of ScrollView immediately.
  • attenuated Boolean Whether the scroll acceleration attenuated, default is true.
Examples
// Vertical scroll to the bottom of the view.
scrollView.scrollTo(cc.p(0, 1), 0.1);

// Horizontal scroll to view right.
scrollView.scrollTo(cc.p(1, 0), 0.1);
scrollToPercentVertical

Scroll the content to the vertical percent position of ScrollView.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:665
Parameters
  • percent Number A value between 0 and 1.
  • timeInSecond Number Scroll time in second, if you don't pass timeInSecond, the content will jump to the vertical percent position of ScrollView immediately.
  • attenuated Boolean Whether the scroll acceleration attenuated, default is true. // Scroll to middle position. scrollView.scrollToPercentVertical(0.5, 0.1);
stopAutoScroll

Stop auto scroll immediately

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:690
setContentPosition

Modify the content position.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:700
Parameters
  • position Vec2 The position in content's parent space.
getContentPosition

Query the content's position in its parent space.

meta description
Returns Position
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:715
isScrolling

Query whether the user is currently dragging the ScrollView to scroll it

meta description
Returns Boolean
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:725
isAutoScrolling

Query whether the ScrollView is currently scrolling because of a bounceback or inertia slowdown.

meta description
Returns Boolean
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCScrollView.js:735
update

Update is called every frame, if the Component is enabled.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:234
Parameters
  • dt Number the delta time in seconds it took to complete the last frame
lateUpdate

LateUpdate is called every frame, if the Component is enabled.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:243
__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.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:251
onLoad

When attaching to an active node or its node first activated. onLoad is always called before any start functions, this allows you to order initialization of scripts.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:262
start

Called before all scripts' update if the Component is enabled the first time. Usually used to initialize some logic which need to be called after all components' onload methods called.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:273
onEnable

Called when this component becomes enabled and its node is active.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:284
onDisable

Called when this component becomes disabled or its node becomes inactive.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:292
onDestroy

Called when this component will be destroyed.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:300
onFocusInEditor
meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:308
onLostFocusInEditor
meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:313
resetInEditor

Called to initialize the component or node’s properties when adding the component the first time or when the Reset command is used. This function is only called in editor.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:318
addComponent

Adds a component class to the node. You can also add component to node by passing in the name of the script.

meta description
Returns Component
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:328
Parameters
  • typeOrClassName Function | String the constructor or the class name of the component to add
Examples
var sprite = node.addComponent(cc.Sprite);
var test = node.addComponent("Test");
getComponent

Returns the component of supplied type if the node has one attached, null if it doesn't.
You can also get component in the node by passing in the name of the script.

meta description
Returns Component
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:346
Parameters
Examples
// get sprite component.
var sprite = node.getComponent(cc.Sprite);
// get custom test calss.
var test = node.getComponent("Test");
getComponents

Returns all components of supplied Type in the node.

meta description
Returns Component[]
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:370
Parameters
Examples
var sprites = node.getComponents(cc.Sprite);
var tests = node.getComponents("Test");
getComponentInChildren

Returns the component of supplied type in any of its children using depth first search.

meta description
Returns Component
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:388
Parameters
Examples
var sprite = node.getComponentInChildren(cc.Sprite);
var Test = node.getComponentInChildren("Test");
getComponentsInChildren

Returns the components of supplied type in self or any of its children using depth first search.

meta description
Returns Component[]
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:406
Parameters
Examples
var sprites = node.getComponentsInChildren(cc.Sprite);
var tests = node.getComponentsInChildren("Test");
_getLocalBounds

If the component's bounding box is different from the node's, you can implement this method to supply a custom axis aligned bounding box (AABB), so the editor's scene view can perform hit test properly.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:426
Parameters
  • out_rect Rect the Rect to receive the bounding box
onRestore

onRestore is called after the user clicks the Reset item in the Inspector's context menu or performs an undo operation on this component.

If the component contains the "internal state", short for "temporary member variables which not included
in its CCClass properties", then you may need to implement this function.

The editor will call the getset accessors of your component to record/restore the component's state
for undo/redo operation. However, in extreme cases, it may not works well. Then you should implement
this function to manually synchronize your component's "internal states" with its public properties.
Once you implement this function, all the getset accessors of your component will not be called when
the user performs an undo/redo operation. Which means that only the properties with default value
will be recorded or restored by editor.

Similarly, the editor may failed to reset your component correctly in extreme cases. Then if you need
to support the reset menu, you should manually synchronize your component's "internal states" with its
properties in this function. Once you implement this function, all the getset accessors of your component
will not be called during reset operation. Which means that only the properties with default value
will be reset by editor.

This function is only called in editor mode.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:439
schedule

Schedules a custom selector.
If the selector is already scheduled, then the interval parameter will be updated without scheduling it again.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:541
Parameters
  • 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.
Examples
var timeCallback = function (dt) {
  cc.log("time: " + dt);
}
this.schedule(timeCallback, 1);
scheduleOnce

Schedules a callback function that runs only once, with a delay of 0 or larger.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:578
Parameters
  • callback function A function wrapped as a selector
  • delay Number The amount of time that the first tick will wait before execution.
Examples
var timeCallback = function (dt) {
  cc.log("time: " + dt);
}
this.scheduleOnce(timeCallback, 2);
unschedule

Unschedules a custom callback function.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:595
Parameters
  • callback_fn function A function wrapped as a selector
Examples
this.unschedule(_callback);
unscheduleAllCallbacks

unschedule all scheduled callback functions: custom callback functions, and the 'update' callback function.
Actions are not affected by this method.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/components/CCComponent.js:611
Examples
this.unscheduleAllCallbacks();
destroy

Destroy this Object, and release all its own references to other objects.
Actual object destruction will delayed until before rendering.
After destroy, this CCObject is not usable any more. You can use cc.isValid(obj) to check whether the object is destroyed before accessing it.

meta description
Returns Boolean
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/platform/CCObject.js:246
Examples
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; } } }

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/platform/CCObject.js:379
_onPreDestroy

Called before the object being destroyed.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/platform/CCObject.js:412
_serialize

The customized serialization for this object. (Editor Only)

meta description
Returns object
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/platform/CCObject.js:437
Parameters
_deserialize

Init this object from the custom serialized data.

meta description
Defined in https:/github.com/cocos-creator/engine/blob/master/cocos2d/core/platform/CCObject.js:447
Parameters
  • data Object the serialized json data
  • ctx _Deserializer

Events

page-turning Event

Module: cc

Note: This event is emitted from the node to which the component belongs.

Index

Details

scroll-to-top Event

Module: cc

Note: This event is emitted from the node to which the component belongs.

Index

Details

scroll-to-bottom Event

Module: cc

Note: This event is emitted from the node to which the component belongs.

Index

Details

scroll-to-left Event

Module: cc

Note: This event is emitted from the node to which the component belongs.

Index

Details

scroll-to-right Event

Module: cc

Note: This event is emitted from the node to which the component belongs.

Index

Details

scrolling Event

Module: cc

Note: This event is emitted from the node to which the component belongs.

Index

Details

bounce-bottom Event

Module: cc

Note: This event is emitted from the node to which the component belongs.

Index

Details

bounce-top Event

Module: cc

Note: This event is emitted from the node to which the component belongs.

Index

Details

bounce-left Event

Module: cc

Note: This event is emitted from the node to which the component belongs.

Index

Details

bounce-right Event

Module: cc

Note: This event is emitted from the node to which the component belongs.

Index

Details

scroll-ended Event

Module: cc

Note: This event is emitted from the node to which the component belongs.

Index

Details

touch-up Event

Module: cc

Note: This event is emitted from the node to which the component belongs.

Index

Details

scroll-began Event

Module: cc

Note: This event is emitted from the node to which the component belongs.

Index

Details

results matching ""

    No results matching ""