/*--------------------------------------------------------------------------------------------- * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. See License.txt in the project root for license information. *--------------------------------------------------------------------------------------------*/ // import 'vs/css!./actionbar'; import * as platform from '../../../../../vs/base/common/platform'; import * as nls from '../../../../../vs/nls'; import { Disposable } from '../../../../../vs/base/common/lifecycle'; import { IAction, IActionRunner, Action, IActionChangeEvent, ActionRunner, Separator, } from '../../../../../vs/base/common/actions'; import * as types from '../../../../../vs/base/common/types'; import { EventType as TouchEventType, Gesture, } from '../../../../../vs/base/browser/touch'; import { DataTransfers } from '../../../../../vs/base/browser/dnd'; import { isFirefox } from '../../../../../vs/base/browser/browser'; import { $, addDisposableListener, append, EventHelper, EventLike, EventType, } from '../../../../../vs/base/browser/dom'; import { IActionViewItem } from '../../../../../vs/base/browser/ui/actionbar/actionbar'; export interface IBaseActionViewItemOptions { draggable?: boolean; isMenu?: boolean; useEventAsContext?: boolean; } export class BaseActionViewItem extends Disposable implements IActionViewItem { element: HTMLElement | undefined; _context: unknown; _action: IAction; private _actionRunner: IActionRunner | undefined; constructor( context: unknown, action: IAction, protected options: IBaseActionViewItemOptions = {} ) { super(); this._context = context || this; this._action = action; if (action instanceof Action) { this._register( action.onDidChange((event) => { if (!this.element) { // we have not been rendered yet, so there // is no point in updating the UI return; } this.handleActionChangeEvent(event); }) ); } } private handleActionChangeEvent(event: IActionChangeEvent): void { if (event.enabled !== undefined) { this.updateEnabled(); } if (event.checked !== undefined) { this.updateChecked(); } if (event.class !== undefined) { this.updateClass(); } if (event.label !== undefined) { this.updateLabel(); this.updateTooltip(); } if (event.tooltip !== undefined) { this.updateTooltip(); } } get actionRunner(): IActionRunner { if (!this._actionRunner) { this._actionRunner = this._register(new ActionRunner()); } return this._actionRunner; } set actionRunner(actionRunner: IActionRunner) { this._actionRunner = actionRunner; } getAction(): IAction { return this._action; } isEnabled(): boolean { return this._action.enabled; } setActionContext(newContext: unknown): void { this._context = newContext; } render(container: HTMLElement): void { const element = (this.element = container); this._register(Gesture.addTarget(container)); const enableDragging = this.options && this.options.draggable; if (enableDragging) { container.draggable = true; if (isFirefox) { // Firefox: requires to set a text data transfer to get going this._register( addDisposableListener(container, EventType.DRAG_START, (e) => e.dataTransfer?.setData(DataTransfers.TEXT, this._action.label) ) ); } } this._register( addDisposableListener(element, TouchEventType.Tap, (e) => this.onClick(e)) ); this._register( addDisposableListener(element, EventType.MOUSE_DOWN, (e) => { if (!enableDragging) { EventHelper.stop(e, true); // do not run when dragging is on because that would disable it } if (this._action.enabled && e.button === 0) { element.classList.add('active'); } }) ); if (platform.isMacintosh) { // macOS: allow to trigger the button when holding Ctrl+key and pressing the // main mouse button. This is for scenarios where e.g. some interaction forces // the Ctrl+key to be pressed and hold but the user still wants to interact // with the actions (for example quick access in quick navigation mode). this._register( addDisposableListener(element, EventType.CONTEXT_MENU, (e) => { if (e.button === 0 && e.ctrlKey === true) { this.onClick(e); } }) ); } this._register( addDisposableListener(element, EventType.CLICK, (e) => { EventHelper.stop(e, true); // menus do not use the click event if (!(this.options && this.options.isMenu)) { platform.setImmediate(() => this.onClick(e)); } }) ); this._register( addDisposableListener(element, EventType.DBLCLICK, (e) => { EventHelper.stop(e, true); }) ); [EventType.MOUSE_UP, EventType.MOUSE_OUT].forEach((event) => { this._register( addDisposableListener(element, event, (e) => { EventHelper.stop(e); element.classList.remove('active'); }) ); }); } onClick(event: EventLike): void { EventHelper.stop(event, true); const context = types.isUndefinedOrNull(this._context) ? this.options?.useEventAsContext ? event : undefined : this._context; this.actionRunner.run(this._action, context); } // Only set the tabIndex on the element once it is about to get focused // That way this element wont be a tab stop when it is not needed #106441 focus(): void { if (this.element) { this.element.tabIndex = 0; this.element.focus(); this.element.classList.add('focused'); } } blur(): void { if (this.element) { this.element.blur(); this.element.tabIndex = -1; this.element.classList.remove('focused'); } } setFocusable(focusable: boolean): void { if (this.element) { this.element.tabIndex = focusable ? 0 : -1; } } get trapsArrowNavigation(): boolean { return false; } protected updateEnabled(): void { // implement in subclass } protected updateLabel(): void { // implement in subclass } protected updateTooltip(): void { // implement in subclass } protected updateClass(): void { // implement in subclass } protected updateChecked(): void { // implement in subclass } override dispose(): void { if (this.element) { this.element.remove(); this.element = undefined; } super.dispose(); } } export interface IActionViewItemOptions extends IBaseActionViewItemOptions { icon?: boolean; label?: boolean; keybinding?: string | null; } export class ActionViewItem extends BaseActionViewItem { protected label: HTMLElement | undefined; protected override options: IActionViewItemOptions; private cssClass?: string; constructor( context: unknown, action: IAction, options: IActionViewItemOptions = {} ) { super(context, action, options); this.options = options; this.options.icon = options.icon !== undefined ? options.icon : false; this.options.label = options.label !== undefined ? options.label : true; this.cssClass = ''; } override render(container: HTMLElement): void { super.render(container); if (this.element) { this.label = append(this.element, $('a.action-label')); } if (this.label) { if (this._action.id === Separator.ID) { this.label.setAttribute('role', 'presentation'); // A separator is a presentation item } else { if (this.options.isMenu) { this.label.setAttribute('role', 'menuitem'); } else { this.label.setAttribute('role', 'button'); } } } if (this.options.label && this.options.keybinding && this.element) { append(this.element, $('span.keybinding')).textContent = this.options.keybinding; } this.updateClass(); this.updateLabel(); this.updateTooltip(); this.updateEnabled(); this.updateChecked(); } // Only set the tabIndex on the element once it is about to get focused // That way this element wont be a tab stop when it is not needed #106441 override focus(): void { if (this.label) { this.label.tabIndex = 0; this.label.focus(); } } override blur(): void { if (this.label) { this.label.tabIndex = -1; } } override setFocusable(focusable: boolean): void { if (this.label) { this.label.tabIndex = focusable ? 0 : -1; } } override updateLabel(): void { if (this.options.label && this.label) { this.label.textContent = this.getAction().label; } } override updateTooltip(): void { let title: string | null = null; if (this.getAction().tooltip) { title = this.getAction().tooltip; } else if ( !this.options.label && this.getAction().label && this.options.icon ) { title = this.getAction().label; if (this.options.keybinding) { title = nls.localize( { key: 'titleLabel', comment: ['action title', 'action keybinding'] }, '{0} ({1})', title, this.options.keybinding ); } } if (title && this.label) { this.label.title = title; } } override updateClass(): void { if (this.cssClass && this.label) { this.label.classList.remove(...this.cssClass.split(' ')); } if (this.options.icon) { this.cssClass = this.getAction().class; if (this.label) { this.label.classList.add('codicon'); if (this.cssClass) { this.label.classList.add(...this.cssClass.split(' ')); } } this.updateEnabled(); } else { if (this.label) { this.label.classList.remove('codicon'); } } } override updateEnabled(): void { if (this.getAction().enabled) { if (this.label) { this.label.removeAttribute('aria-disabled'); this.label.classList.remove('disabled'); } if (this.element) { this.element.classList.remove('disabled'); } } else { if (this.label) { this.label.setAttribute('aria-disabled', 'true'); this.label.classList.add('disabled'); } if (this.element) { this.element.classList.add('disabled'); } } } override updateChecked(): void { if (this.label) { if (this.getAction().checked) { this.label.classList.add('checked'); } else { this.label.classList.remove('checked'); } } } }