Interface IDocumentManagerDialogs

Dialog interfaces for document management.

interface IDocumentManagerDialogs {
    confirmClose(
        options: IDocumentManagerDialogs.ConfirmClose.IOptions,
    ): Promise<IDocumentManagerDialogs.ConfirmClose.IResult>;
    rename(context: DocumentRegistry.Context): Promise<null | void>;
    saveBeforeClose(
        options: IDocumentManagerDialogs.SaveBeforeClose.IOptions,
    ): Promise<IDocumentManagerDialogs.SaveBeforeClose.IResult>;
}

Implemented by

DocumentManagerDialogs

Index

Methods

confirmClose rename saveBeforeClose

Methods

confirmClose

confirmClose(
options: IDocumentManagerDialogs.ConfirmClose.IOptions,
): Promise<IDocumentManagerDialogs.ConfirmClose.IResult>
Show a dialog asking whether to close a document.

This dialog is shown when closing a clean (non-dirty) document and confirmClosingDocument is true.
Parameters
- options: IDocumentManagerDialogs.ConfirmClose.IOptions
  Options for the dialog
Returns Promise<IDocumentManagerDialogs.ConfirmClose.IResult>
A promise that resolves to a result object
- Defined in packages/docmanager/src/tokens.ts:133

rename

rename(context: DocumentRegistry.Context): Promise<null | void>
Show a dialog to rename a file.
Parameters
- context: DocumentRegistry.Context
  The document context
Returns Promise<null | void>
A promise that resolves when rename is complete or null if cancelled
- Defined in packages/docmanager/src/tokens.ts:122

saveBeforeClose

saveBeforeClose(
options: IDocumentManagerDialogs.SaveBeforeClose.IOptions,
): Promise<IDocumentManagerDialogs.SaveBeforeClose.IResult>
Show a dialog asking whether to save before closing a dirty document.
Parameters
- options: IDocumentManagerDialogs.SaveBeforeClose.IOptions
  Options for the dialog
Returns Promise<IDocumentManagerDialogs.SaveBeforeClose.IResult>
A promise that resolves to a result object
- Defined in packages/docmanager/src/tokens.ts:143