EditBox Class

Extends Component

Module: cc Parent Module: cc

cc.EditBox is a component for inputing text, you can use it to gather small amounts of text from users.

Index

Properties

• string String Input string of EditBox.
• textLabel Label The Label component attached to the node for EditBox's input text label
• placeholderLabel Label !en The Label component attached to the node for EditBox's placeholder text label
• background Sprite The Sprite component attached to the node for EditBox's background
• backgroundImage SpriteFrame The background image of EditBox.
• returnType EditBox.KeyboardReturnType The return key type of EditBox.
• inputFlag EditBox.InputFlag Set the input flags that are to be applied to the EditBox.
• inputMode EditBox.InputMode Set the input mode of the edit box.
• fontSize Number Font size of the input text.
• lineHeight Number Change the lineHeight of displayed text.
• fontColor Color Font color of the input text.
• placeholder String The display text of placeholder.
• placeholderFontSize Number The font size of placeholder.
• placeholderFontColor Color The font color of placeholder.
• maxLength Number The maximize input length of EditBox.
• stayOnTop Boolean The input is always visible and be on top of the game view (only useful on Web), this property will be removed on v2.1
• tabIndex Number Set the tabIndex of the DOM input element (only useful on Web).
• editingDidBegan Component.EventHandler[] The event handler to be called when EditBox began to edit text.
• textChanged Component.EventHandler[] The event handler to be called when EditBox text changes.
• editingDidEnded Component.EventHandler[] The event handler to be called when EditBox edit ends.
• editingReturn Component.EventHandler[] The event handler to be called when return key is pressed.
• __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

• setFocus Let the EditBox get focus, this method will be removed on v2.1
• focus Let the EditBox get focus
• blur Let the EditBox lose focus
• isFocused Determine whether EditBox is getting focus or not.
• destroy call the destroy method on this component or the associated node explicitly.
• 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....
• _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.

Events

• editing-did-began Note: This event is emitted from the node to which the component belongs.
• editing-did-ended Note: This event is emitted from the node to which the component belongs.
• text-changed Note: This event is emitted from the node to which the component belongs.
• editing-return Note: This event is emitted from the node to which the component belongs.

Details

Properties

string

Input string of EditBox.

textLabel

The Label component attached to the node for EditBox's input text label

placeholderLabel

!en The Label component attached to the node for EditBox's placeholder text label !zh 输入框占位符节点上挂载的 Label 组件对象

background

The Sprite component attached to the node for EditBox's background

backgroundImage

The background image of EditBox. This property will be removed in the future, use editBox.background instead please.

returnType

The return key type of EditBox. Note: it is meaningless for web platforms and desktop platforms.

inputFlag

Set the input flags that are to be applied to the EditBox.

inputMode

Set the input mode of the edit box. If you pass ANY, it will create a multiline EditBox.

fontSize

Font size of the input text. This property will be removed in the future, use editBox.textLabel.fontSize instead please.

lineHeight

Change the lineHeight of displayed text. This property will be removed in the future, use editBox.textLabel.lineHeight instead.

fontColor

Font color of the input text. This property will be removed in the future, use editBox.textLabel.node.color instead.

placeholder

The display text of placeholder.

placeholderFontSize

The font size of placeholder. This property will be removed in the future, use editBox.placeholderLabel.fontSize instead.

placeholderFontColor

The font color of placeholder. This property will be removed in the future, use editBox.placeholderLabel.node.color instead.

maxLength

The maximize input length of EditBox.

• If pass a value less than 0, it won't limit the input number of characters.
• If pass 0, it doesn't allow input any characters.

stayOnTop

The input is always visible and be on top of the game view (only useful on Web), this property will be removed on v2.1 !zh 输入框总是可见，并且永远在游戏视图的上面（这个属性只有在 Web 上面修改有意义），该属性会在 v2.1 中移除 Note: only available on Web at the moment.

tabIndex

Set the tabIndex of the DOM input element (only useful on Web).

editingDidBegan

The event handler to be called when EditBox began to edit text.

textChanged

The event handler to be called when EditBox text changes.

editingDidEnded

The event handler to be called when EditBox edit ends.

editingReturn

The event handler to be called when return key is pressed. Windows is not supported.

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

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

setFocus

Let the EditBox get focus, this method will be removed on v2.1

focus

Let the EditBox get focus

blur

Let the EditBox lose focus

isFocused

Determine whether EditBox is getting focus or not.

destroy

if you don't need the EditBox and it isn't in any running Scene, you should call the destroy method on this component or the associated node explicitly. Otherwise, the created DOM element won't be removed from web page.

Examples

editbox.node.parent = null;  // or  editbox.node.removeFromParent(false);
// when you don't need editbox anymore
editbox.node.destroy();

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.

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.

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

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.

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.

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.

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.

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();

_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

editing-did-began Event

Module: cc Parent Module: cc

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

Index

Details

editing-did-ended Event

Module: cc Parent Module: cc

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

Index

Details

text-changed Event

Module: cc Parent Module: cc

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

Index

Details

editing-return Event

Module: cc Parent Module: cc

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

Index

Details