Theia API Documentation v1.65.0
Eclipse Theia Website
GitHub
Preparing search index...
@theia/plugin-ext
common/plugin-api-rpc
CustomEditorsExt
Interface CustomEditorsExt
interface
CustomEditorsExt
{
$createCustomDocument
(
resource
:
UriComponents
,
viewType
:
string
,
openContext
:
CustomDocumentOpenContext
,
cancellation
:
CancellationToken
,
)
:
Promise
<
{
editable
:
boolean
}
>
;
$disposeCustomDocument
(
resource
:
UriComponents
,
viewType
:
string
,
)
:
Promise
<
void
>
;
$disposeEdits
(
resourceComponents
:
UriComponents
,
viewType
:
string
,
editIds
:
number
[]
,
)
:
void
;
$onMoveCustomEditor
(
handle
:
string
,
newResource
:
UriComponents
,
viewType
:
string
,
)
:
Promise
<
void
>
;
$redo
(
resource
:
UriComponents
,
viewType
:
string
,
editId
:
number
,
isDirty
:
boolean
,
)
:
Promise
<
void
>
;
$resolveWebviewEditor
(
resource
:
UriComponents
,
newWebviewHandle
:
string
,
viewType
:
string
,
title
:
string
,
position
:
number
,
options
:
WebviewPanelOptions
,
cancellation
:
CancellationToken
,
)
:
Promise
<
void
>
;
$revert
(
resource
:
UriComponents
,
viewType
:
string
,
cancellation
:
CancellationToken
,
)
:
Promise
<
void
>
;
$save
(
resource
:
UriComponents
,
viewType
:
string
,
cancellation
:
CancellationToken
,
)
:
Promise
<
void
>
;
$saveAs
(
resource
:
UriComponents
,
viewType
:
string
,
targetResource
:
UriComponents
,
cancellation
:
CancellationToken
,
)
:
Promise
<
void
>
;
$undo
(
resource
:
UriComponents
,
viewType
:
string
,
editId
:
number
,
isDirty
:
boolean
,
)
:
Promise
<
void
>
;
}
Implemented by
CustomEditorsExtImpl
Index
Methods
$create
Custom
Document
$dispose
Custom
Document
$dispose
Edits
$on
Move
Custom
Editor
$redo
$resolve
Webview
Editor
$revert
$save
$save
As
$undo
Methods
$create
Custom
Document
$createCustomDocument
(
resource
:
UriComponents
,
viewType
:
string
,
openContext
:
CustomDocumentOpenContext
,
cancellation
:
CancellationToken
,
)
:
Promise
<
{
editable
:
boolean
}
>
Parameters
resource
:
UriComponents
viewType
:
string
openContext
:
CustomDocumentOpenContext
cancellation
:
CancellationToken
Returns
Promise
<
{
editable
:
boolean
}
>
$dispose
Custom
Document
$disposeCustomDocument
(
resource
:
UriComponents
,
viewType
:
string
)
:
Promise
<
void
>
Parameters
resource
:
UriComponents
viewType
:
string
Returns
Promise
<
void
>
$dispose
Edits
$disposeEdits
(
resourceComponents
:
UriComponents
,
viewType
:
string
,
editIds
:
number
[]
,
)
:
void
Parameters
resourceComponents
:
UriComponents
viewType
:
string
editIds
:
number
[]
Returns
void
$on
Move
Custom
Editor
$onMoveCustomEditor
(
handle
:
string
,
newResource
:
UriComponents
,
viewType
:
string
,
)
:
Promise
<
void
>
$backup(resource: UriComponents, viewType: string, cancellation: CancellationToken): Promise
;
Parameters
handle
:
string
newResource
:
UriComponents
viewType
:
string
Returns
Promise
<
void
>
$redo
$redo
(
resource
:
UriComponents
,
viewType
:
string
,
editId
:
number
,
isDirty
:
boolean
,
)
:
Promise
<
void
>
Parameters
resource
:
UriComponents
viewType
:
string
editId
:
number
isDirty
:
boolean
Returns
Promise
<
void
>
$resolve
Webview
Editor
$resolveWebviewEditor
(
resource
:
UriComponents
,
newWebviewHandle
:
string
,
viewType
:
string
,
title
:
string
,
position
:
number
,
options
:
WebviewPanelOptions
,
cancellation
:
CancellationToken
,
)
:
Promise
<
void
>
Parameters
resource
:
UriComponents
newWebviewHandle
:
string
viewType
:
string
title
:
string
position
:
number
options
:
WebviewPanelOptions
cancellation
:
CancellationToken
Returns
Promise
<
void
>
$revert
$revert
(
resource
:
UriComponents
,
viewType
:
string
,
cancellation
:
CancellationToken
,
)
:
Promise
<
void
>
Parameters
resource
:
UriComponents
viewType
:
string
cancellation
:
CancellationToken
Returns
Promise
<
void
>
$save
$save
(
resource
:
UriComponents
,
viewType
:
string
,
cancellation
:
CancellationToken
,
)
:
Promise
<
void
>
Parameters
resource
:
UriComponents
viewType
:
string
cancellation
:
CancellationToken
Returns
Promise
<
void
>
$save
As
$saveAs
(
resource
:
UriComponents
,
viewType
:
string
,
targetResource
:
UriComponents
,
cancellation
:
CancellationToken
,
)
:
Promise
<
void
>
Parameters
resource
:
UriComponents
viewType
:
string
targetResource
:
UriComponents
cancellation
:
CancellationToken
Returns
Promise
<
void
>
$undo
$undo
(
resource
:
UriComponents
,
viewType
:
string
,
editId
:
number
,
isDirty
:
boolean
,
)
:
Promise
<
void
>
Parameters
resource
:
UriComponents
viewType
:
string
editId
:
number
isDirty
:
boolean
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
$create
Custom
Document
$dispose
Custom
Document
$dispose
Edits
$on
Move
Custom
Editor
$redo
$resolve
Webview
Editor
$revert
$save
$save
As
$undo
Eclipse Theia Website
GitHub
Theia API Documentation v1.65.0
Loading...
$backup(resource: UriComponents, viewType: string, cancellation: CancellationToken): Promise;