Theia API Documentation v1.65.0
Eclipse Theia Website
GitHub
Preparing search index...
@theia/plugin-ext
common/plugin-api-rpc
TextEditorsMain
Interface TextEditorsMain
interface
TextEditorsMain
{
$getDiffInformation
(
id
:
string
)
:
Promise
<
LineChange
[]
>
;
$registerTextEditorDecorationType
(
key
:
string
,
options
:
DecorationRenderOptions
,
)
:
void
;
$removeTextEditorDecorationType
(
key
:
string
)
:
void
;
$save
(
uri
:
UriComponents
)
:
PromiseLike
<
undefined
|
UriComponents
>
;
$saveAll
(
includeUntitled
?:
boolean
)
:
Promise
<
boolean
>
;
$saveAs
(
uri
:
UriComponents
)
:
PromiseLike
<
undefined
|
UriComponents
>
;
$tryApplyEdits
(
id
:
string
,
modelVersionId
:
number
,
edits
:
SingleEditOperation
[]
,
opts
:
ApplyEditsOptions
,
)
:
Promise
<
boolean
>
;
$tryApplyWorkspaceEdit
(
workspaceEditDto
:
WorkspaceEditDto
,
metadata
?:
WorkspaceEditMetadataDto
,
)
:
Promise
<
boolean
>
;
$tryHideEditor
(
id
:
string
)
:
Promise
<
void
>
;
$tryInsertSnippet
(
id
:
string
,
template
:
string
,
selections
:
Range
[]
,
opts
:
SnippetEditOptions
,
)
:
Promise
<
boolean
>
;
$tryRevealRange
(
id
:
string
,
range
:
Range
,
revealType
:
TextEditorRevealType
,
)
:
Promise
<
void
>
;
$trySetDecorations
(
id
:
string
,
key
:
string
,
ranges
:
DecorationOptions
[]
,
)
:
Promise
<
void
>
;
$trySetDecorationsFast
(
id
:
string
,
key
:
string
,
ranges
:
number
[]
,
)
:
Promise
<
void
>
;
$trySetOptions
(
id
:
string
,
options
:
TextEditorConfigurationUpdate
,
)
:
Promise
<
void
>
;
$trySetSelections
(
id
:
string
,
selections
:
Selection
[]
)
:
Promise
<
void
>
;
$tryShowTextDocument
(
uri
:
UriComponents
,
options
?:
TextDocumentShowOptions
,
)
:
Promise
<
void
>
;
}
Implemented by
TextEditorsMainImpl
Index
Methods
$get
Diff
Information
$register
Text
Editor
Decoration
Type
$remove
Text
Editor
Decoration
Type
$save
$save
All
$save
As
$try
Apply
Edits
$try
Apply
Workspace
Edit
$try
Hide
Editor
$try
Insert
Snippet
$try
Reveal
Range
$try
Set
Decorations
$try
Set
Decorations
Fast
$try
Set
Options
$try
Set
Selections
$try
Show
Text
Document
Methods
$get
Diff
Information
$getDiffInformation
(
id
:
string
)
:
Promise
<
LineChange
[]
>
Parameters
id
:
string
Returns
Promise
<
LineChange
[]
>
$register
Text
Editor
Decoration
Type
$registerTextEditorDecorationType
(
key
:
string
,
options
:
DecorationRenderOptions
,
)
:
void
Parameters
key
:
string
options
:
DecorationRenderOptions
Returns
void
$remove
Text
Editor
Decoration
Type
$removeTextEditorDecorationType
(
key
:
string
)
:
void
Parameters
key
:
string
Returns
void
$save
$save
(
uri
:
UriComponents
)
:
PromiseLike
<
undefined
|
UriComponents
>
Parameters
uri
:
UriComponents
Returns
PromiseLike
<
undefined
|
UriComponents
>
$save
All
$saveAll
(
includeUntitled
?:
boolean
)
:
Promise
<
boolean
>
Parameters
Optional
includeUntitled
:
boolean
Returns
Promise
<
boolean
>
$save
As
$saveAs
(
uri
:
UriComponents
)
:
PromiseLike
<
undefined
|
UriComponents
>
Parameters
uri
:
UriComponents
Returns
PromiseLike
<
undefined
|
UriComponents
>
$try
Apply
Edits
$tryApplyEdits
(
id
:
string
,
modelVersionId
:
number
,
edits
:
SingleEditOperation
[]
,
opts
:
ApplyEditsOptions
,
)
:
Promise
<
boolean
>
Parameters
id
:
string
modelVersionId
:
number
edits
:
SingleEditOperation
[]
opts
:
ApplyEditsOptions
Returns
Promise
<
boolean
>
$try
Apply
Workspace
Edit
$tryApplyWorkspaceEdit
(
workspaceEditDto
:
WorkspaceEditDto
,
metadata
?:
WorkspaceEditMetadataDto
,
)
:
Promise
<
boolean
>
Parameters
workspaceEditDto
:
WorkspaceEditDto
Optional
metadata
:
WorkspaceEditMetadataDto
Returns
Promise
<
boolean
>
$try
Hide
Editor
$tryHideEditor
(
id
:
string
)
:
Promise
<
void
>
Parameters
id
:
string
Returns
Promise
<
void
>
$try
Insert
Snippet
$tryInsertSnippet
(
id
:
string
,
template
:
string
,
selections
:
Range
[]
,
opts
:
SnippetEditOptions
,
)
:
Promise
<
boolean
>
Parameters
id
:
string
template
:
string
selections
:
Range
[]
opts
:
SnippetEditOptions
Returns
Promise
<
boolean
>
$try
Reveal
Range
$tryRevealRange
(
id
:
string
,
range
:
Range
,
revealType
:
TextEditorRevealType
,
)
:
Promise
<
void
>
Parameters
id
:
string
range
:
Range
revealType
:
TextEditorRevealType
Returns
Promise
<
void
>
$try
Set
Decorations
$trySetDecorations
(
id
:
string
,
key
:
string
,
ranges
:
DecorationOptions
[]
,
)
:
Promise
<
void
>
Parameters
id
:
string
key
:
string
ranges
:
DecorationOptions
[]
Returns
Promise
<
void
>
$try
Set
Decorations
Fast
$trySetDecorationsFast
(
id
:
string
,
key
:
string
,
ranges
:
number
[]
)
:
Promise
<
void
>
Parameters
id
:
string
key
:
string
ranges
:
number
[]
Returns
Promise
<
void
>
$try
Set
Options
$trySetOptions
(
id
:
string
,
options
:
TextEditorConfigurationUpdate
,
)
:
Promise
<
void
>
Parameters
id
:
string
options
:
TextEditorConfigurationUpdate
Returns
Promise
<
void
>
$try
Set
Selections
$trySetSelections
(
id
:
string
,
selections
:
Selection
[]
)
:
Promise
<
void
>
Parameters
id
:
string
selections
:
Selection
[]
Returns
Promise
<
void
>
$try
Show
Text
Document
$tryShowTextDocument
(
uri
:
UriComponents
,
options
?:
TextDocumentShowOptions
,
)
:
Promise
<
void
>
Parameters
uri
:
UriComponents
Optional
options
:
TextDocumentShowOptions
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
$get
Diff
Information
$register
Text
Editor
Decoration
Type
$remove
Text
Editor
Decoration
Type
$save
$save
All
$save
As
$try
Apply
Edits
$try
Apply
Workspace
Edit
$try
Hide
Editor
$try
Insert
Snippet
$try
Reveal
Range
$try
Set
Decorations
$try
Set
Decorations
Fast
$try
Set
Options
$try
Set
Selections
$try
Show
Text
Document
Eclipse Theia Website
GitHub
Theia API Documentation v1.65.0
Loading...