IntelliJ Platform 插件开发文档翻译 - 文档 Document

文档 Document 是一个可编辑的Unicode字符序列,一般作为虚拟文件的内容使用。文档中的换行符被标准化为\nIntelliJ Platform在读取和保存文档时会显式地对其进行编码和换行符标准化。

如何获取文档?

  • 从action获取: e.getData(PlatformDataKeys.EDITOR).getDocument()
  • 从虚拟文件获取: FileDocumentManager.getDocument(). 如果文件还没被从硬盘加载,这个方法将帮你完成加载过程。你过你只是要打开文档或者文档已经被修改,请使用 FileDocumentManager.getCachedDocument() 从缓存读取。
  • 从PSI 文件读取: PsiDocumentManager.getInstance().getDocument() or PsiDocumentManager.getInstance().getCachedDocument()

文档能做什么?

把它看成简单的"纯文本", 对纯文本能做的任何操作都支持(字符序列,而不是java元素树)。

文档从何而来?

文档实例由需要访问文件文本内容的操作创建(特别地,这需要为文件创建PSI)。并且,文档不与任何临时创建的虚拟文件关联,比如为了在对话框的文本编辑框中展示内容而建立的虚拟文件。

文档的生命周期?

文档 实例是VirtualFile的弱引用。因此,未修改的Document实例如果不再被任何对象引用,将会被GC回收。如果文档内容再次被访问,会再创建新的实例。使用持久的数据结构引用你的Document可能造成内存泄露。

如何创建文档?

如果你需要在硬盘伤创建新文件,你不会创建Document: 你应该创建一个PSI文件,然后获取它的Document.如果你需要创建一个不依赖任何东西的Document实例,可以使用EditorFactory.createDocument.

如何获取文档变化通知?

  • Document.addDocumentListener 允许你接收指定Document实例的变化通知。
  • EditorFactory.getEventMulticaster().addDocumentListener允许你接收所有打开的Document实例的变化通知。
  • FileDocumentManager.addFileDocumentManagerListener 允许你接收所有Document从硬盘reload和save事件通知。

文档的工作细则?

事实上是在讨论读写规则。任何修改文档内容的操作必须通过CommandProcessor.getInstance().executeCommand()命令执行。executeCommand()可以嵌套执行,并且最外层的调用会被添加到撤销堆栈上。如果一条命令同时修改了多个文档,撤销操作默认弹出一个确认对话框供用户确认。

如果一个文档对应的文件是只读的(比如,没有从版本控制系统中检出),文件修改操作会失败。因此,在你修改一个文档之前,确保使用ReadonlyStatusHandler.getInstance(project).ensureFilesWritable()方法检出文件。

所有文档修改方法的字符串参数必须使用\n换行符。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,684评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,143评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,214评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,788评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,796评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,665评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,027评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,679评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,346评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,664评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,766评论 1 331
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,412评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,015评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,974评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,073评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,501评论 2 343

推荐阅读更多精彩内容