ScrollView Class

Extends Component

Module: cc

Layout container for a view hierarchy that can be scrolled by the user, allowing it to be larger than the physical display.

Index

Properties

• 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

• 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

• 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

content

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

horizontal

Enable horizontal scroll.

vertical

Enable vertical scroll.

inertia

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

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.

elastic

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

bounceDuration

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

horizontalScrollBar

The horizontal scrollbar reference.

verticalScrollBar

The vertical scrollbar reference.

scrollEvents

Scrollview events callback

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.

__eventTargets

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

node

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

Examples

cc.log(comp.node);

uuid

The uuid for editor.

Examples

cc.log(comp.uuid);

_enabled

enabled

indicates whether this component is enabled or not.

Examples

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

enabledInHierarchy

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

Examples

cc.log(comp.enabledInHierarchy);

_isOnLoadCalled

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

Examples

cc.log(this._isOnLoadCalled > 0);

_name

_objFlags

name

The name of the object.

Examples

obj.name = "New Obj";

isValid

Indicates whether the object is not yet destroyed.

Examples

cc.log(obj.isValid);

Methods

scrollToBottom

Scroll the content to the bottom boundary of ScrollView.

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.

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.

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.

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.

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.

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.

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.

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.

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.

getMaxScrollOffset

Get the maximize available scroll offset

scrollToPercentHorizontal

Scroll the content to the horizontal percent position of ScrollView.

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.

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.

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

setContentPosition

Modify the content position.

Parameters

• position Vec2 The position in content's parent space.

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.

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.

__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.

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.

Parameters

• typeOrClassName Function | String

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.

Parameters

• typeOrClassName Function | String

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.

Parameters

• typeOrClassName Function | String

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.

Parameters

• typeOrClassName Function | String

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.

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.

schedule

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

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.

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.

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.

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.

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; } } }

_onPreDestroy

Called before the object being destroyed.

_serialize

The customized serialization for this object. (Editor Only)

Parameters

• exporting Boolean

_deserialize

Init this object from the custom serialized data.

Parameters

• data Object the serialized json data
• ctx _Deserializer

Events

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