@eclipse-glsp/client
Version:
A sprotty-based client for GLSP
74 lines • 3.4 kB
TypeScript
/********************************************************************************
* Copyright (c) 2024 EclipseSource and others.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the Eclipse
* Public License v. 2.0 are satisfied: GNU General Public License, version 2
* with the GNU Classpath Exception which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
********************************************************************************/
import { Action, Disposable, MaybeActions } from '@eclipse-glsp/sprotty';
import type { IFeedbackActionDispatcher, IFeedbackEmitter } from './feedback-action-dispatcher';
/**
* A helper object to collect, submit and undo feedback consisting of several actions.
*/
export declare class FeedbackEmitter implements IFeedbackEmitter, Disposable {
protected feedbackDispatcher: IFeedbackActionDispatcher;
protected id: number;
protected feedbackActions: (Action | undefined)[];
protected cleanupActions: MaybeActions[];
protected deregistration?: Disposable;
constructor(feedbackDispatcher: IFeedbackActionDispatcher);
/**
* Adds an action as part of this emitters feedback. Please note that the action is only applied as feedback
* once the {@link submit} method is called.
*
* @param action feedback action
* @param cleanupAction action that undoes the feedback action. This is only triggered when {@link revert} or {@link dispose} is called.
*/
add(action?: Action, cleanupAction?: MaybeActions): this;
/**
* Merges the feedback of another emitter into this emitter.
*
* @param feedback feedback to merge
*/
merge(feedback: FeedbackEmitter): this;
/**
* Removes the action as part of this emitters feedback. If the action cannot be found, this is a no-op.
* Please note that this also removed the corresponding cleanup action.
* If the feedback has already been submitted as part of the {@link submit} method, the whole feedback must be de-registered
* or a new feedback without the given action needs to be registered.
*
* @param action feedback action
*/
remove(action: Action): this;
/**
* Clears any, not yet registered feedback actions and their corresponding cleanup actions.
*/
clear(): this;
/**
* Registers any pending actions as feedback. Any previously submitted feedback becomes invalid.
*/
submit(): this;
/**
* Removes the registered feedback WITHOUT calling any potential cleanup actions
* Any pending actions can still be registerd with the {@link submit} method.
*/
discard(): this;
/**
* Removes the registered feedback and calls the registered cleanup actions.
* Any pending actions can still be registerd with the {@link submit} method.
*/
revert(): this;
/**
* Disposes any registered feedback and any pending, not yet registered feedback actions.
*/
dispose(): this;
}
//# sourceMappingURL=feedback-emitter.d.ts.map