Widget Class

Extends Component

Module: cc

Stores and manipulate the anchoring based on its parent. Widget are used for GUI but can also be used for other things. Widget will adjust current node's position and size automatically, but the results after adjustment can not be obtained until the next frame unless you call updateAlignment manually.

Index

Properties
  • target Node Specifies an alignment target that can only be one of the parent nodes of the current node.
  • isAlignTop Boolean Whether to align the top.
  • isAlignVerticalCenter Boolean Vertically aligns the midpoint, This will open the other vertical alignment options cancel.
  • isAlignBottom Boolean Whether to align the bottom.
  • isAlignLeft Boolean Whether to align the left.
  • isAlignHorizontalCenter Boolean Horizontal aligns the midpoint.
  • isAlignRight Boolean Whether to align the right.
  • isStretchWidth Boolean Whether the stretched horizontally, when enable the left and right alignment will be stretched horizontally,...
  • isStretchHeight Boolean Whether the stretched vertically, when enable the left and right alignment will be stretched vertically,...
  • top Number The margins between the top of this node and the top of parent node,...
  • bottom Number The margins between the bottom of this node and the bottom of parent node,...
  • left Number The margins between the left of this node and the left of parent node,...
  • right Number The margins between the right of this node and the right of parent node,...
  • horizontalCenter Number Horizontal aligns the midpoint offset value,...
  • verticalCenter Number Vertical aligns the midpoint offset value,...
  • isAbsoluteHorizontalCenter Boolean If true, horizontalCenter is pixel margin, otherwise is percentage (0 - 1) margin.
  • isAbsoluteVerticalCenter Boolean If true, verticalCenter is pixel margin, otherwise is percentage (0 - 1) margin.
  • isAbsoluteTop Boolean If true, top is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's height.
  • isAbsoluteBottom Boolean If true, bottom is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's height.
  • isAbsoluteLeft Boolean If true, left is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's width.
  • isAbsoluteRight Boolean If true, right is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's width.
  • alignMode Widget.AlignMode Specifies the alignment mode of the Widget, which determines when the widget should refresh.
  • _alignFlags Number
  • isAlignOnce Boolean then immediately disables the current component.
  • __eventTargets Array Register all related EventTargets,...
  • node Node The node this component is attached to.
  • 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
  • updateAlignment Immediately perform the widget alignment.
  • update This is a lifecycle method.
  • lateUpdate This is a lifecycle method.
  • __preload __preload is called before every onLoad.
  • onLoad When attaching to an active node or its node first activated.
  • start Called before all scripts' update if the Component is enabled the first time.
  • onEnable This is a lifecycle method.
  • onDisable This is a lifecycle method.
  • onDestroy This is a lifecycle method.
  • 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.
  • addComponent Adds a component class to the node.
  • getComponent Returns the component of supplied type if the node has one attached, null if it doesn't....
  • 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
  • onRestore for undo/redo operation.
  • schedule Schedules a custom selector....
  • 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....
  • destroy Actual object destruction will delayed until before rendering.
  • _destruct Clear all references in the instance.
  • _onPreDestroy Called before the object being destroyed.
  • _serialize The customized serialization for this object.
  • _deserialize Init this object from the custom serialized data.

Details

Properties

target

Specifies an alignment target that can only be one of the parent nodes of the current node. The default value is null, and when null, indicates the current parent.

meta description
Type Node
Defined in cocos2d/core/components/CCWidget.js:95
isAlignTop

Whether to align the top.

meta description
Type Boolean
Defined in cocos2d/core/components/CCWidget.js:119
isAlignVerticalCenter

Vertically aligns the midpoint, This will open the other vertical alignment options cancel.

meta description
Type Boolean
Defined in cocos2d/core/components/CCWidget.js:137
isAlignBottom

Whether to align the bottom.

meta description
Type Boolean
Defined in cocos2d/core/components/CCWidget.js:164
isAlignLeft

Whether to align the left.

meta description
Type Boolean
Defined in cocos2d/core/components/CCWidget.js:182
isAlignHorizontalCenter

Horizontal aligns the midpoint. This will open the other horizontal alignment options canceled.

meta description
Type Boolean
Defined in cocos2d/core/components/CCWidget.js:200
isAlignRight

Whether to align the right.

meta description
Type Boolean
Defined in cocos2d/core/components/CCWidget.js:227
isStretchWidth

Whether the stretched horizontally, when enable the left and right alignment will be stretched horizontally, the width setting is invalid (read only).

meta description
Type Boolean
Defined in cocos2d/core/components/CCWidget.js:245
isStretchHeight

Whether the stretched vertically, when enable the left and right alignment will be stretched vertically, then height setting is invalid (read only)

meta description
Type Boolean
Defined in cocos2d/core/components/CCWidget.js:262
top

The margins between the top of this node and the top of parent node, the value can be negative, Only available in 'isAlignTop' open.

meta description
Type Number
Defined in cocos2d/core/components/CCWidget.js:282
bottom

The margins between the bottom of this node and the bottom of parent node, the value can be negative, Only available in 'isAlignBottom' open.

meta description
Type Number
Defined in cocos2d/core/components/CCWidget.js:302
left

The margins between the left of this node and the left of parent node, the value can be negative, Only available in 'isAlignLeft' open.

meta description
Type Number
Defined in cocos2d/core/components/CCWidget.js:322

The margins between the right of this node and the right of parent node, the value can be negative, Only available in 'isAlignRight' open.

meta description
Type Number
Defined in cocos2d/core/components/CCWidget.js:342
horizontalCenter

Horizontal aligns the midpoint offset value, the value can be negative, Only available in 'isAlignHorizontalCenter' open.

meta description
Type Number
Defined in cocos2d/core/components/CCWidget.js:362
verticalCenter

Vertical aligns the midpoint offset value, the value can be negative, Only available in 'isAlignVerticalCenter' open.

meta description
Type Number
Defined in cocos2d/core/components/CCWidget.js:381
isAbsoluteHorizontalCenter

If true, horizontalCenter is pixel margin, otherwise is percentage (0 - 1) margin.

meta description
Type Boolean
Defined in cocos2d/core/components/CCWidget.js:402
isAbsoluteVerticalCenter

If true, verticalCenter is pixel margin, otherwise is percentage (0 - 1) margin.

meta description
Type Boolean
Defined in cocos2d/core/components/CCWidget.js:419
isAbsoluteTop

If true, top is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's height.

meta description
Type Boolean
Defined in cocos2d/core/components/CCWidget.js:436
isAbsoluteBottom

If true, bottom is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's height.

meta description
Type Boolean
Defined in cocos2d/core/components/CCWidget.js:455
isAbsoluteLeft

If true, left is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's width.

meta description
Type Boolean
Defined in cocos2d/core/components/CCWidget.js:474
isAbsoluteRight

If true, right is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's width.

meta description
Type Boolean
Defined in cocos2d/core/components/CCWidget.js:493
alignMode

Specifies the alignment mode of the Widget, which determines when the widget should refresh.

meta description
Type Widget.AlignMode
Defined in cocos2d/core/components/CCWidget.js:512
Examples
widget.alignMode = cc.Widget.AlignMode.ON_WINDOW_RESIZE;
_alignFlags
meta description
Type Number
Defined in cocos2d/core/components/CCWidget.js:534
isAlignOnce

When turned on, it will only be aligned once at the end of the onEnable frame, then immediately disables the current component. This will allow the script or animation to continue controlling the current node. Note: It will still be aligned at the frame when onEnable is called.

meta description
Type Boolean
Defined in cocos2d/core/components/CCWidget.js:670
__eventTargets

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

meta description
Type Array
Defined in 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 cocos2d/core/components/CCComponent.js:75
Examples
cc.log(comp.node);
uuid

The uuid for editor.

meta description
Type String
Defined in cocos2d/core/components/CCComponent.js:106
Examples
cc.log(comp.uuid);
_enabled
meta description
Type Boolean
Defined in cocos2d/core/components/CCComponent.js:147
enabled

indicates whether this component is enabled or not.

meta description
Type Boolean
Defined in cocos2d/core/components/CCComponent.js:154
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 cocos2d/core/components/CCComponent.js:185
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 cocos2d/core/components/CCComponent.js:201
Examples
cc.log(this._isOnLoadCalled > 0);
_name
meta description
Type String
Defined in cocos2d/core/platform/CCObject.js:76
_objFlags
meta description
Type Number
Defined in cocos2d/core/platform/CCObject.js:83
name

The name of the object.

meta description
Type String
Defined in cocos2d/core/platform/CCObject.js:243
Examples
obj.name = "New Obj";
isValid

Indicates whether the object is not yet destroyed. (It will not be available after being destroyed)
When an object's destroy is called, it is actually destroyed after the end of this frame. So isValid will return false from the next frame, while isValid in the current frame will still be true. If you want to determine whether the current frame has called destroy, use cc.isValid(obj, true), but this is often caused by a particular logical requirements, which is not normally required.

meta description
Type Boolean
Defined in cocos2d/core/platform/CCObject.js:261
Examples
var node = new cc.Node();
cc.log(node.isValid);    // true
node.destroy();
cc.log(node.isValid);    // true, still valid in this frame
// after a frame...
cc.log(node.isValid);    // false, destroyed in the end of last frame

Methods

updateAlignment

Immediately perform the widget alignment. You need to manually call this method only if you need to get the latest results after the alignment before the end of current frame.

meta description
Defined in cocos2d/core/components/CCWidget.js:649
Examples
widget.top = 10;       // change top margin
cc.log(widget.node.y); // not yet changed
widget.updateAlignment();
cc.log(widget.node.y); // changed
update

Update is called every frame, if the Component is enabled.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:222
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.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:233
__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 cocos2d/core/components/CCComponent.js:243
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.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:254
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.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:267
onEnable

Called when this component becomes enabled and its node is active.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:280
onDisable

Called when this component becomes disabled or its node becomes inactive.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:290
onDestroy

Called when this component will be destroyed.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:300
onFocusInEditor
meta description
Defined in cocos2d/core/components/CCComponent.js:310
onLostFocusInEditor
meta description
Defined in cocos2d/core/components/CCComponent.js:315
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 cocos2d/core/components/CCComponent.js:320
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 cocos2d/core/components/CCComponent.js:330
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 cocos2d/core/components/CCComponent.js:348
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 cocos2d/core/components/CCComponent.js:372
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 cocos2d/core/components/CCComponent.js:390
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 cocos2d/core/components/CCComponent.js:408
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 cocos2d/core/components/CCComponent.js:428
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 cocos2d/core/components/CCComponent.js:441
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 cocos2d/core/components/CCComponent.js:535
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 cocos2d/core/components/CCComponent.js:572
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 cocos2d/core/components/CCComponent.js:589
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 cocos2d/core/components/CCComponent.js:605
Examples
this.unscheduleAllCallbacks();
destroy

Destroy this Object, and release all its own references to other objects.
Actual object destruction will delayed until before rendering. From the next frame, this object 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 cocos2d/core/platform/CCObject.js:296
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 cocos2d/core/platform/CCObject.js:430
_onPreDestroy

Called before the object being destroyed.

meta description
Defined in cocos2d/core/platform/CCObject.js:463
_serialize

The customized serialization for this object. (Editor Only)

meta description
Returns object
Defined in cocos2d/core/platform/CCObject.js:488
Parameters
_deserialize

Init this object from the custom serialized data.

meta description
Defined in cocos2d/core/platform/CCObject.js:498
Parameters
  • data Object the serialized json data
  • ctx _Deserializer

results matching ""

    No results matching ""