Files
cocos4/cocos/ui/toggle-container.ts
T
PP 4914116834 optimize SystemEventType and NodeEventType (#8678)
* remove recomendation for usage of string type of event

* deprecate KEY_DOWN KEY_UP event

* support SystemEventType.KEYBOARD_DOWN && SystemEventType.KEYBOARD_UP

* deprecate some useless properties

* implement keyboard pal

* remove SystemEventType toString()

update

* fix instantiating EventTouch

* optimize deprecated info

* support native keyboard KEYBOARD_DOWN event

* remove usage of event code

* fix deprecating pure value properties

* optimize deprecating Event type

* optimize deprecating getEventCode()

update

* optimize deprecating eventType

* optimize deprecating isPressed

* optimize deprecating keybaord event

* optimize deprecating rawEvent

* Revert "fix deprecating pure value properties"

This reverts commit 60d586532496fa1f422f05c54a922b86d1dc96ee.

* fix deprecate pure value properties

* Revert "fix deprecate pure value properties"

This reverts commit a83f1725fedfbd7af445892912aacab8e8502147.

* fix deprecating pure value property

* update

updaate

* deprecate some EventType enum in SystemEventType and NodeEventType

* optimize

* update

update

* update

* update

* fix CI

* fix CI

* fix Circular dependency

* fix Circular dependency
2021-06-07 19:06:29 +08:00

174 lines
6.0 KiB
TypeScript

/*
Copyright (c) 2013-2016 Chukong Technologies Inc.
Copyright (c) 2017-2020 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 engine source code (the "Software"), a limited,
worldwide, royalty-free, non-assignable, revocable and non-exclusive license
to use Cocos Creator solely to develop games on your target platforms. You shall
not use Cocos Creator software for developing other software or tools that's
used for developing games. You are not granted to publish, distribute,
sublicense, and/or sell copies of Cocos Creator.
The software or tools in this License Agreement are licensed, not sold.
Xiamen Yaji Software Co., Ltd. reserves all rights not expressly granted to you.
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.
*/
/**
* @packageDocumentation
* @module ui
*/
import { ccclass, help, executeInEditMode, executionOrder, menu, tooltip, type, serializable } from 'cc.decorator';
import { Component, EventHandler as ComponentEventHandler } from '../core/components';
import { Toggle } from './toggle';
import { legacyCC } from '../core/global-exports';
import { NodeEventType } from '../core/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 () {
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 () {
return this.node.children.map((item) => {
const toggle = item.getComponent('cc.Toggle') as Toggle;
if (toggle && toggle.enabled) {
return toggle;
}
return null;
}).filter(Boolean);
}
public onEnable () {
this.ensureValidState();
this.node.on(NodeEventType.CHILD_ADDED, this.ensureValidState, this);
this.node.on(NodeEventType.CHILD_REMOVED, this.ensureValidState, this);
}
public onDisable () {
this.node.off(NodeEventType.CHILD_ADDED, this.ensureValidState, this);
this.node.off(NodeEventType.CHILD_REMOVED, this.ensureValidState, this);
}
public activeToggles () {
return this.toggleItems.filter((x) => x!.isChecked);
}
public anyTogglesChecked () {
return !!this.toggleItems.find((x) => x!.isChecked);
}
/**
* @en
* Refresh the state of the managed toggles.
*
* @zh
* 刷新管理的 toggle 状态。
*
* @param toggle - 需要被更新的 toggle。
* @param emitEvent - 是否需要触发事件
*/
public notifyToggleCheck (toggle: Toggle, emitEvent = true) {
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);
}
}
public ensureValidState () {
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;
}
}
}
}