mirror of
https://github.com/cocos/cocos4.git
synced 2026-11-21 08:02:39 +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>
174 lines
6.1 KiB
TypeScript
174 lines
6.1 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, executeInEditMode, executionOrder, menu, tooltip, type, serializable } from 'cc.decorator';
|
|
import { Component, EventHandler as ComponentEventHandler } from '../scene-graph';
|
|
import { Toggle } from './toggle';
|
|
import { legacyCC } from '../core/global-exports';
|
|
import { NodeEventType } from '../scene-graph/node-event';
|
|
|
|
/**
|
|
* @en
|
|
* ToggleContainer is not a visible UI component but a way to modify the behavior of a set of Toggles. <br/>
|
|
* Toggles that belong to the same group could only have one of them to be switched on at a time.<br/>
|
|
* Note: All the first layer child node containing the toggle component will auto be added to the container.
|
|
*
|
|
* @zh
|
|
* ToggleGroup 不是一个可见的 UI 组件,它可以用来修改一组 Toggle 组件的行为。当一组 Toggle 属于同一个 ToggleGroup 的时候,<br/>
|
|
* 任何时候只能有一个 Toggle 处于选中状态。
|
|
*/
|
|
|
|
@ccclass('cc.ToggleContainer')
|
|
@help('i18n:cc.ToggleContainer')
|
|
@executionOrder(110)
|
|
@menu('UI/ToggleContainer')
|
|
@executeInEditMode
|
|
export class ToggleContainer extends Component {
|
|
@serializable
|
|
protected _allowSwitchOff = false;
|
|
/**
|
|
* @en
|
|
* If this setting is true, a toggle could be switched off and on when pressed.
|
|
* If it is false, it will make sure there is always only one toggle could be switched on
|
|
* and the already switched on toggle can't be switched off.
|
|
*
|
|
* @zh
|
|
* 如果这个设置为 true,那么 toggle 按钮在被点击的时候可以反复地被选中和未选中。
|
|
*/
|
|
@tooltip('i18n:toggle_group.allowSwitchOff')
|
|
get allowSwitchOff (): boolean {
|
|
return this._allowSwitchOff;
|
|
}
|
|
|
|
set allowSwitchOff (value) {
|
|
this._allowSwitchOff = value;
|
|
}
|
|
|
|
/**
|
|
* @en
|
|
* If Toggle is clicked, it will trigger event's handler.
|
|
*
|
|
* @zh
|
|
* Toggle 按钮的点击事件列表。
|
|
*/
|
|
@type([ComponentEventHandler])
|
|
@serializable
|
|
@tooltip('i18n:toggle_group.check_events')
|
|
public checkEvents: ComponentEventHandler[] = [];
|
|
|
|
/**
|
|
* @en
|
|
* Read only property, return the toggle items array reference managed by ToggleContainer.
|
|
*
|
|
* @zh
|
|
* 只读属性,返回 toggleContainer 管理的 toggle 数组引用。
|
|
*/
|
|
get toggleItems (): Toggle[] {
|
|
return this.node.children.map((item) => {
|
|
const toggle = item.getComponent('cc.Toggle') as Toggle;
|
|
if (toggle && toggle.enabled) {
|
|
return toggle;
|
|
}
|
|
return null;
|
|
}).filter(Boolean) as Toggle[];
|
|
}
|
|
|
|
public onEnable (): void {
|
|
this.ensureValidState();
|
|
this.node.on(NodeEventType.CHILD_ADDED, this.ensureValidState, this);
|
|
this.node.on(NodeEventType.CHILD_REMOVED, this.ensureValidState, this);
|
|
}
|
|
|
|
public onDisable (): void {
|
|
this.node.off(NodeEventType.CHILD_ADDED, this.ensureValidState, this);
|
|
this.node.off(NodeEventType.CHILD_REMOVED, this.ensureValidState, this);
|
|
}
|
|
|
|
public activeToggles (): Toggle[] {
|
|
return this.toggleItems.filter((x) => x.isChecked);
|
|
}
|
|
|
|
public anyTogglesChecked (): boolean {
|
|
return !!this.toggleItems.find((x) => x.isChecked);
|
|
}
|
|
|
|
/**
|
|
* @en
|
|
* Refresh the state of the managed toggles.
|
|
*
|
|
* @zh
|
|
* 刷新管理的 toggle 状态。
|
|
*
|
|
* @param toggle @en The toggle to be updated. @zh 需要被更新的切换键。
|
|
* @param emitEvent @en Whether events are needed to be emitted. @zh 是否需要触发事件。
|
|
*/
|
|
public notifyToggleCheck (toggle: Toggle, emitEvent = true): void {
|
|
if (!this.enabledInHierarchy) { return; }
|
|
|
|
for (let i = 0; i < this.toggleItems.length; i++) {
|
|
const item = this.toggleItems[i]!;
|
|
if (item === toggle) {
|
|
continue;
|
|
}
|
|
if (emitEvent) {
|
|
item.isChecked = false;
|
|
} else {
|
|
item.setIsCheckedWithoutNotify(false);
|
|
}
|
|
}
|
|
|
|
if (this.checkEvents) {
|
|
legacyCC.Component.EventHandler.emitEvents(this.checkEvents, toggle);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @en Ensure toggles state valid.
|
|
* @zh 确保 toggles 状态有效。
|
|
*/
|
|
public ensureValidState (): void {
|
|
const toggles = this.toggleItems;
|
|
if (!this._allowSwitchOff && !this.anyTogglesChecked() && toggles.length !== 0) {
|
|
const toggle = toggles[0]!;
|
|
toggle.isChecked = true;
|
|
this.notifyToggleCheck(toggle);
|
|
}
|
|
|
|
const activeToggles = this.activeToggles();
|
|
if (activeToggles.length > 1) {
|
|
const firstToggle = activeToggles[0];
|
|
for (let i = 0; i < activeToggles.length; ++i) {
|
|
const toggle = activeToggles[i];
|
|
if (toggle === firstToggle) {
|
|
continue;
|
|
}
|
|
toggle.isChecked = false;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
legacyCC.ToggleContainer = ToggleContainer;
|