Theia API Documentation v1.65.0
Eclipse Theia Website
GitHub
Preparing search index...
@theia/plugin-ext
main/browser/text-editors-main
TextEditorsMainImpl
Class TextEditorsMainImpl
Implements
TextEditorsMain
Disposable
Index
Constructors
constructor
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
dispose
inject
Remote
Uris
to
Remote
Uri
Constructors
constructor
new
TextEditorsMainImpl
(
editorsAndDocuments
:
EditorsAndDocumentsMain
,
documents
:
DocumentsMain
,
rpc
:
RPCProtocol
,
container
:
Container
,
)
:
TextEditorsMainImpl
Parameters
editorsAndDocuments
:
EditorsAndDocumentsMain
documents
:
DocumentsMain
rpc
:
RPCProtocol
container
:
Container
Returns
TextEditorsMainImpl
Methods
$get
Diff
Information
$getDiffInformation
(
id
:
string
)
:
Promise
<
ILineChange
[]
>
Parameters
id
:
string
Returns
Promise
<
ILineChange
[]
>
$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
(
dto
:
WorkspaceEditDto
,
metadata
?:
WorkspaceEditMetadataDto
,
)
:
Promise
<
boolean
>
Parameters
dto
:
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
,
ranges
:
Range
[]
,
opts
:
SnippetEditOptions
,
)
:
Promise
<
boolean
>
Parameters
id
:
string
template
:
string
ranges
:
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
>
dispose
dispose
()
:
void
Dispose this object.
Returns
void
Protected
inject
Remote
Uris
injectRemoteUris
(
options
:
DecorationRenderOptions
|
ThemeDecorationInstanceRenderOptions
,
)
:
void
Parameters
options
:
DecorationRenderOptions
|
ThemeDecorationInstanceRenderOptions
Returns
void
Protected
to
Remote
Uri
toRemoteUri
(
uri
?:
UriComponents
)
:
undefined
|
UriComponents
Parameters
Optional
uri
:
UriComponents
Returns
undefined
|
UriComponents
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
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
dispose
inject
Remote
Uris
to
Remote
Uri
Eclipse Theia Website
GitHub
Theia API Documentation v1.65.0
Loading...
Dispose this object.