mirror of
https://github.com/cocos/cocos4.git
synced 2026-11-20 23:52:40 +08:00
509d73b27d
* PR1: add explicit function return type (#15311) * PR4: add explicit function return type (#15314) * [ci skip][AUTO]: Automated code generating update: 8843bfe54cd3f8e6f84432948716c8d130ecb233 (#15314) (#15357) Co-authored-by: cocos-robot <cocos-robot@cocos.com> * add function return type * fix version checking * fix return type --------- Co-authored-by: Cocos Robot <48829427+cocos-robot@users.noreply.github.com> Co-authored-by: cocos-robot <cocos-robot@cocos.com>
216 lines
6.5 KiB
TypeScript
216 lines
6.5 KiB
TypeScript
/*
|
|
Copyright (c) 2013-2016 Chukong Technologies Inc.
|
|
Copyright (c) 2017-2023 Xiamen Yaji Software Co., Ltd.
|
|
|
|
http://www.cocos.com
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights to
|
|
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
|
of the Software, and to permit persons to whom the Software is furnished to do so,
|
|
subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
THE SOFTWARE.
|
|
*/
|
|
|
|
import { ccclass, help, requireComponent, executionOrder, menu, tooltip, displayOrder, type, serializable } from 'cc.decorator';
|
|
import { EDITOR_NOT_IN_PREVIEW } from 'internal:constants';
|
|
import { EventHandler as ComponentEventHandler } from '../scene-graph/component-event-handler';
|
|
import { UITransform } from '../2d/framework';
|
|
import { Sprite } from '../2d/components/sprite';
|
|
import { ToggleContainer } from './toggle-container';
|
|
import { extendsEnum } from '../core/data/utils/extends-enum';
|
|
import { EventType as ButtonEventType, Button } from './button';
|
|
import { legacyCC } from '../core/global-exports';
|
|
|
|
enum EventType {
|
|
TOGGLE = 'toggle',
|
|
}
|
|
|
|
/**
|
|
* @en
|
|
* The toggle component is a CheckBox, when it used together with a ToggleGroup,
|
|
* it could be treated as a RadioButton.
|
|
*
|
|
* @zh
|
|
* Toggle 是一个 CheckBox,当它和 ToggleGroup 一起使用的时候,可以变成 RadioButton。
|
|
*/
|
|
@ccclass('cc.Toggle')
|
|
@help('i18n:cc.Toggle')
|
|
@executionOrder(110)
|
|
@menu('UI/Toggle')
|
|
@requireComponent(UITransform)
|
|
export class Toggle extends Button {
|
|
/**
|
|
* @en
|
|
* When this value is true, the check mark component will be enabled,
|
|
* otherwise the check mark component will be disabled.
|
|
*
|
|
* @zh
|
|
* 如果这个设置为 true,则 check mark 组件会处于 enabled 状态,否则处于 disabled 状态。
|
|
*/
|
|
@displayOrder(1)
|
|
@tooltip('i18n:toggle.isChecked')
|
|
get isChecked (): boolean {
|
|
return this._isChecked;
|
|
}
|
|
|
|
set isChecked (value) {
|
|
this._set(value);
|
|
}
|
|
|
|
/**
|
|
* @en
|
|
* The image used for the checkmark.
|
|
*
|
|
* @zh
|
|
* Toggle 处于选中状态时显示的图片。
|
|
*/
|
|
@type(Sprite)
|
|
@displayOrder(1)
|
|
@tooltip('i18n:toggle.checkMark')
|
|
get checkMark (): Sprite | null {
|
|
return this._checkMark;
|
|
}
|
|
|
|
set checkMark (value) {
|
|
if (this._checkMark === value) {
|
|
return;
|
|
}
|
|
|
|
this._checkMark = value;
|
|
}
|
|
|
|
/**
|
|
* @deprecated since v3.7.0, this is an engine private interface that will be removed in the future.
|
|
*/
|
|
set _resizeToTarget (value: boolean) {
|
|
if (value) {
|
|
this._resizeNodeToTargetNode();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @deprecated since v3.5.0, this is an engine private interface that will be removed in the future.
|
|
*/
|
|
get _toggleContainer (): ToggleContainer | null {
|
|
const parent = this.node.parent!;
|
|
if (legacyCC.Node.isNode(parent)) {
|
|
return parent.getComponent('cc.ToggleContainer') as ToggleContainer;
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* @en Enum for toggle event.
|
|
* @zh toggle 事件枚举。
|
|
*/
|
|
public static EventType = extendsEnum(EventType, ButtonEventType);
|
|
|
|
/**
|
|
* @en
|
|
* If Toggle is clicked, it will trigger event's handler.
|
|
*
|
|
* @zh
|
|
* Toggle 按钮的点击事件列表。
|
|
*/
|
|
@type([ComponentEventHandler])
|
|
@serializable
|
|
@tooltip('i18n:toggle.check_events')
|
|
public checkEvents: ComponentEventHandler[] = [];
|
|
@serializable
|
|
protected _isChecked = true;
|
|
@serializable
|
|
protected _checkMark: Sprite | null = null;
|
|
|
|
protected _internalToggle (): void {
|
|
this.isChecked = !this.isChecked;
|
|
}
|
|
|
|
protected _set (value: boolean, emitEvent = true): void {
|
|
if (this._isChecked == value) return;
|
|
|
|
this._isChecked = value;
|
|
|
|
const group = this._toggleContainer;
|
|
if (group && group.enabled && this.enabled) {
|
|
if (value || (!group.anyTogglesChecked() && !group.allowSwitchOff)) {
|
|
this._isChecked = true;
|
|
group.notifyToggleCheck(this, emitEvent);
|
|
}
|
|
}
|
|
|
|
this.playEffect();
|
|
if (emitEvent) {
|
|
this._emitToggleEvents();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @deprecated since v3.7.0, this is an engine private interface that will be removed in the future.
|
|
*/
|
|
public playEffect (): void {
|
|
if (this._checkMark) {
|
|
this._checkMark.node.active = this._isChecked;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @en
|
|
* Set isChecked without invoking checkEvents.
|
|
*
|
|
* @zh
|
|
* 设置 isChecked 而不调用 checkEvents 回调。
|
|
*
|
|
* @param value @en Whether this toggle is pressed. @zh 是否被按下。
|
|
*/
|
|
public setIsCheckedWithoutNotify (value: boolean): void {
|
|
this._set(value, false);
|
|
}
|
|
|
|
public onEnable (): void {
|
|
super.onEnable();
|
|
this.playEffect();
|
|
if (!EDITOR_NOT_IN_PREVIEW) {
|
|
this.node.on(Toggle.EventType.CLICK, this._internalToggle, this);
|
|
}
|
|
}
|
|
|
|
public onDisable (): void {
|
|
super.onDisable();
|
|
if (!EDITOR_NOT_IN_PREVIEW) {
|
|
this.node.off(Toggle.EventType.CLICK, this._internalToggle, this);
|
|
}
|
|
}
|
|
|
|
protected _emitToggleEvents (): void {
|
|
this.node.emit(Toggle.EventType.TOGGLE, this);
|
|
if (this.checkEvents) {
|
|
ComponentEventHandler.emitEvents(this.checkEvents, this);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @en
|
|
* Note: This event is emitted from the node to which the component belongs.
|
|
*
|
|
* @zh
|
|
* 注意:此事件是从该组件所属的 Node 上面派发出来的,需要用 node.on 来监听。
|
|
* @event toggle
|
|
* @param event @en The event when toggle is pressed up or down. @zh 切换键被按下或抬起时发送的事件。
|
|
* @param toggle @en The Toggle component. @zh 切换键组件。
|
|
*/
|
|
|
|
legacyCC.Toggle = Toggle;
|