IntelliJ IDEA插件开发:保存选项卡组,持久保存它们,并在用户请求时重新加载一组选项卡 [英] IntelliJ IDEA Plugin Development: Save groups of tabs, save them persistently and reload a set of tabs if requested by the user
问题描述
我目前正在编写一个IntelliJ插件。我希望能够存储/恢复一组标签以在不同的标签会话之间切换(与浏览器插件相似,如会话管理器或 Session Buddy )。
I am currently at the move to write an IntelliJ plugin. I want to be able to store/restore a set of tabs to switch between different tab sessions (comparable to browser plugins like Session Manager or Session Buddy).
因此我基本上需要三种行动:
Therefore i need basically three types of actions:
- 阅读打开的标签(使用哪个文件和编辑器?)
- 将该信息作为标签会话持续存储
- 打开所选会话的标签并关闭所有其他
我查看了可用的操作: IdeActions.java - 似乎没有我正在寻找的东西。但也许我正在寻找错误的地方。任何人都可以告诉我,如果我想要实现的是什么,并给我一些正确方向的指示?
I looked at the available actions: IdeActions.java - it seems that there is not what i am searching for. But maybe i am looking at the wrong place. Can anyone tell me if what's i am trying to achieve is possible and give me some pointers in the right direction?
我成功创建了插件,它可以在Github上找到: http://alp82.github。 com / idea-tabsession /
I succesfully created the plugin and it's available at Github: http://alp82.github.com/idea-tabsession/
它可以在官方插件库中找到:标签会话。
It is available in the official plugin repository: Tab Session.
以下是关于拆分窗口的后续问题:检索和设置拆分窗口设置
Here is a follow-up question regarding splitted windows: Retrieving and setting split window settings
推荐答案
2017年更新
我停止支持此插件,因为IDEA已经支持该功能。您可以轻松保存和加载上下文,如下所示: https://github.com/alp82/idea -tabsession#停止
该插件已准备就绪,可以下载IDEA - >设置 - >插件。源代码位于: https://github.com/alp82/idea-tabsession
The plugin is up and ready and can be downloaded in IDEA -> Settings -> Plugins. Source code is available at: https://github.com/alp82/idea-tabsession
要阅读现在打开的标签,请使用 EditorFactory
和 FileDocumentManager
单身人士:
To read which tabs are open right now, use the EditorFactory
and FileDocumentManager
Singletons:
Editor[] editors = EditorFactory.getInstance().getAllEditors();
FileDocumentManager fileDocManager = FileDocumentManager.getInstance();
for(Editor editor : editors) {
VirtualFile vf = fileDocManager.getFile(editor.getDocument());
String path = vf.getCanonicalPath();
System.out.println("path = " + path);
}
要打开标签,请使用 FileEditorManager
singleton( files
是规范路径的字符串数组):
To open tabs use the FileEditorManager
singleton (files
being a String Array of canonical paths):
FileEditorManager fileEditorManager = FileEditorManager.getInstance(project);
for(String path : files) {
System.out.println("path = " + path);
VirtualFile vf = LocalFileSystem.getInstance().findFileByPath(path);
fileEditorManager.openFile(vf, true, true);
}
长答案
先决条件
Long Answer
Prerequisites
- 激活插件开发,Groovy和UI Designer插件
- 新项目 - > IntelliJ IDEA插件
-
Checkout IDEA社区版来源到任何文件夹:
git clone git://git.jetbrains.org/idea/community.git idea
插件结构
创建插件后,需要编辑位于META-INF文件夹中的plugin.xml 。修改 id
, name
和 description
。
我们需要一个用于持久存储的配置文件。在 src
文件夹中创建 mystorage.xml
文件。现在是时候创建所需的文件了:
We need a configuration file for persistant storage. Create a mystorage.xml
file in your src
folder. It's now time to create the needed files:
SessionComponent.java(使用添加项目组件
向导创建它自动创建所需的xml设置):
SessionComponent.java (create it with the Add Project Component
wizard to automatically create the needed xml settings):
@State(
name = "SessionComponent",
storages = {
@Storage(id = "default", file = StoragePathMacros.PROJECT_FILE),
@Storage(id = "dir", file = StoragePathMacros.PROJECT_CONFIG_DIR + "/mystorage.xml", scheme = StorageScheme.DIRECTORY_BASED)
}
)
public class SessionComponent implements ProjectComponent, PersistentStateComponent<SessionState> {
Project project;
SessionState sessionState;
public SessionComponent(Project project) {
this.project = project;
sessionState = new SessionState();
}
public void initComponent() {
// TODO: insert component initialization logic here
}
@Override
public void loadState(SessionState sessionState) {
System.out.println("load sessionState = " + sessionState);
this.sessionState = sessionState;
}
public void projectOpened() {
// called when project is opened
}
public void projectClosed() {
// called when project is being closed
}
@Nullable
@Override
public SessionState getState() {
System.out.println("save sessionState = " + sessionState);
return sessionState;
}
public void disposeComponent() {
// TODO: insert component disposal logic here
}
@NotNull
public String getComponentName() {
return "SessionComponent";
}
public int saveCurrentTabs() {
Editor[] editors = getOpenEditors();
FileEditorManager fileEditorManager = FileEditorManager.getInstance(project);
VirtualFile[] selectedFiles = fileEditorManager.getSelectedFiles();
FileDocumentManager fileDocManager = FileDocumentManager.getInstance();
sessionState.files = new String[editors.length];
int i = 0;
for(Editor editor : editors) {
VirtualFile vf = fileDocManager.getFile(editor.getDocument());
String path = vf.getCanonicalPath();
System.out.println("path = " + path);
if(path.equals(selectedFiles[0].getCanonicalPath())) {
sessionState.focusedFile = path;
}
sessionState.files[i] = path;
i++;
}
return editors.length;
}
public int loadSession() {
closeCurrentTabs();
FileEditorManager fileEditorManager = FileEditorManager.getInstance(project);
for(String path : sessionState.files) {
System.out.println("path = " + path);
VirtualFile vf = LocalFileSystem.getInstance().findFileByPath(path);
fileEditorManager.openFile(vf, true, true);
}
return sessionState.files.length;
}
public void closeCurrentTabs() {
Editor[] editors = getOpenEditors();
FileEditorManager fileEditorManager = FileEditorManager.getInstance(project);
FileDocumentManager fileDocManager = FileDocumentManager.getInstance();
for(Editor editor : editors) {
System.out.println("editor = " + editor);
VirtualFile vf = fileDocManager.getFile(editor.getDocument());
fileEditorManager.closeFile(vf);
}
}
public void showMessage(String htmlText) {
StatusBar statusBar = WindowManager.getInstance().getStatusBar(project);
JBPopupFactory.getInstance()
.createHtmlTextBalloonBuilder(htmlText, MessageType.INFO, null)
.setFadeoutTime(7500)
.createBalloon()
.show(RelativePoint.getCenterOf(statusBar.getComponent()), Balloon.Position.atRight);
}
private Editor[] getOpenEditors() {
return EditorFactory.getInstance().getAllEditors();
}
}
我们还需要存储类:
public class SessionState {
public String[] files = new String[0];
public String focusedFile = "";
public String toString() {
String result = "";
for (String file : files) {
result += file + ", ";
}
result += "selected: " + focusedFile;
return result;
}
}
组件类应该在插件中有一个条目。像这样的xml:
The component class should have an entry in your plugin.xml like this one:
<project-components>
<component>
<implementation-class>my.package.SessionComponent</implementation-class>
</component>
</project-components>
组件类提供所有需要的功能,但永远不会被使用。因此,我们需要采取措施来执行加载和保存:
The component class offers all needed functionality, but is never be used. Therefore, we need actions to perform loading and saving:
Save.java:
Save.java:
public class Save extends AnAction {
public Save() {
super();
}
public void actionPerformed(AnActionEvent event) {
Project project = event.getData(PlatformDataKeys.PROJECT);
SessionComponent sessionComponent = project.getComponent(SessionComponent.class);
int tabCount = sessionComponent.saveCurrentTabs();
String htmlText = "Saved " + String.valueOf(tabCount) + " tabs";
sessionComponent.showMessage(htmlText);
}
}
Load.java:
Load.java:
public class Load extends AnAction {
public Load() {
super();
}
public void actionPerformed(AnActionEvent event) {
Project project = event.getData(PlatformDataKeys.PROJECT);
SessionComponent sessionComponent = project.getComponent(SessionComponent.class);
int tabCount = sessionComponent.loadSession();
String htmlText = "Loaded " + String.valueOf(tabCount) + " tabs";
sessionComponent.showMessage(htmlText);
}
}
Aaand ......行动!
我们需要的最后一件事是用户界面来选择这些动作。只需将其放入 plugin.xml
:
<actions>
<!-- Add your actions here -->
<group id="MyPlugin.SampleMenu" text="_Sample Menu" description="Sample menu">
<add-to-group group-id="MainMenu" anchor="last" />
<action id="MyPlugin.Save" class="my.package.Save" text="_Save" description="A test menu item" />
<action id="MyPlugin.Load" class="my.package.Load" text="_Load" description="A test menu item" />
</group>
</actions>
插件部署
基本功能是准备。在部署此插件并将其发布到开源社区之前,我将添加对多个会话和一些其他整洁内容的支持。链接将在此处发布,当它在线时。
Plugin Deployment
The basic functionality is ready. I will add support for multiple sessions and some other neat stuff before deploying this plugin and releasing it to the open-source community. Link will be posted here, when it's online.
这篇关于IntelliJ IDEA插件开发:保存选项卡组,持久保存它们,并在用户请求时重新加载一组选项卡的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!