hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-30 10:17:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

documents.md: minor, feedback (IJSDK-1048)

Browse Source
This commit is contained in:
Yann Cébron 2021-03-09 18:35:18 +01:00
parent a7b5edd976
commit 7faa9538a3
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
topics/basics/architectural_overview/documents.md
View File

@ -9,13 +9,13 @@ The *IntelliJ Platform* handles encoding and line break conversions when loading
## How do I get a document?
From an action
From an Action
: `e.getData(PlatformDataKeys.EDITOR).getDocument()`
From a virtual file
From a Virtual File
: `FileDocumentManager.getDocument()`. This call forces the document content to be loaded from disk if it wasn't loaded previously. If only open documents or documents which may have been modified are considered relevant, use `FileDocumentManager.getCachedDocument()` instead.
From a PSI file
From a PSI File
: `PsiDocumentManager.getInstance().getDocument()` or `PsiDocumentManager.getInstance().getCachedDocument()`
## What can I do with a Document?
@ -58,6 +58,8 @@ If the file corresponding to a `Document` is read-only (for example, not checked
Thus, before modifying the `Document`, it is necessary to call `ReadonlyStatusHandler.getInstance(project).ensureFilesWritable()` to check out the file.
All text strings passed to `Document` modification methods (`setText()`, `insertString()`, `replaceString()`) must use only `\n` as line separators.
See also [Working with Text](working_with_text.md#safely-replacing-selected-text-in-the-document) in Editors Basics tutorial.
## Are there any utilities available for working with Documents?