Plugins开发Android area程序员

Android Studio插件开发4--ToolWindow创

2017-03-24  本文已影响625人  街头客

上一篇:Dialog的创建
下一篇:JBPopup的创建

插件已发布

1,在Plugins中搜索CCLines,进行下载安装;
2,源码在Github中开源下载
3,搜索不到的朋友,可以升级一下idea后再尝试,因为插件有跟idea的版本关联;

gif演示效果图

ToolWindow演示效果

以上的ToolWindow演示效果图就是今天我们文章要讲的主要内容,喜欢的记得支持一下~~~

创建ToolWindow

首先说为什么要创建这个ToolWindow控件,上一篇已经创建了Dialog窗口,也读取到了所有已经打开的项目,然后获取需要统计的项目的路径,这样便能遍历读取该录下的所有文件,那么就需要将Log打印出来,所以我需要一个展示的窗口。

上面讲的就是我插件问题集里面的第6个问题,今天我们就来解决这个问题。

说到打印日志,我脑子里最直接的想法就是利用控制台打印。因为我2011年,当时在华为工作的时候,用eclipse开发python,然后公司需要对代码进行检查圈复杂度,我为了方便,就做了一个eclipse插件,实时检查当前编码的文件的圈复杂度,当时就是把Log打印到控制台。

但我在IntelliJ IDEA找了好久,再结合最近集成使用阿里的Freeline,忽然察觉到,它们怎么都需要单独创建一个展示窗口,如下:

阿里的Freeline

然后我就开始想这个应该怎么实现,我看到Freeline跟【Run】、【Android Monitor】都放在同一组,我第一直觉就是它们是控件,那首先得找出这个控件叫什么名字,所以我就去菜单View里面找,找到如下:

Tool Buttons

根据这些信息找到了相关的资料。

好的,我们开始来创建了!

1,创建一个ToolWindow类

创建一个类名为【ToolFactoryCompute】的类,实现ToolWindowFactory接口,重写【createToolWindowContent】即可,代码如下:

/**
 * Tool windows control.控制文本显示 2017/3/18 19:58
 */
public class ToolFactoryCompute implements ToolWindowFactory {

    private ToolWindow myToolWindow;
    private JPanel mPanel;
    private JTextArea txtContent;
    private JScrollPane mScrollPane;
    private JTextArea textArea1;

    /**
     * 创建控件内容 2017/3/24 09:02
     * @param project 项目
     * @param toolWindow 窗口
     */
    @Override
    public void createToolWindowContent(@NotNull Project project, 
                                        @NotNull ToolWindow toolWindow) {
        myToolWindow = toolWindow;

        // 将显示面板添加到显示区 2017/3/18 19:57
        ContentFactory contentFactory = ContentFactory.SERVICE.getInstance();
        Content content = contentFactory.createContent(mPanel, "Control", false);
        toolWindow.getContentManager().addContent(content);
    }

}

2,在plugin.xml添加控件信息

创建好类之后,需要到plugin.xml中添加相关的控件信息,xml如下:

<!--扩展组件注册 要是用到applicationConfigurable即项目配置等就在这里注册-->
<extensions defaultExtensionNs="com.intellij">

  <!-- 自定义控制台输入 -->
  <toolWindow canCloseContents="false" anchor="bottom"
              id="Compute Code Lines" icon="/myToolWindow/chk_normal.png"
              factoryClass="tools.ToolFactoryCompute">
  </toolWindow>

</extensions>

PS:

1),需要在<extensions>标签中添加;
2),canCloseContents:是否允许用户关闭,配置为true,如下:

关闭

3),id:唯一,并且该id会显示在ToolWindow中,如下:

id配置

4),anchor:方向;
5),icon、factoryClass:图标以及关联的类(即上面创建的类);

3,创建一个Form

需要创建一个Form布局文件,绑定【ToolFactoryCompute】类(即上面创建的类),如下:

Form布局文件

4,创建文本显示控件

添加文本控件(JTextArea),但需要将文本控件放置在滚动控件(JScrollPane)中,控件关系如下:

控件关系

5,添加代码

在【createToolWindowContent】中,添加代码,如下:

// 禁止编辑 2017/3/18 19:57
txtContent.setEditable(false);

// 如需设置透明 2017/3/18 21:41
mScrollPane.setOpaque(false);
mScrollPane.getViewport().setOpaque(false); // 一定要这样设置两次
txtContent.setOpaque(false);

// 鼠标事件 2017/3/18 19:57
txtContent.addMouseListener(new MouseAdapter() {
    public void mouseEntered(MouseEvent mouseEvent) {
        txtContent.setCursor(new Cursor(Cursor.TEXT_CURSOR));   //鼠标进入Text区后变为文本输入指针
    }

    public void mouseExited(MouseEvent mouseEvent) {
        txtContent.setCursor(new Cursor(Cursor.DEFAULT_CURSOR));   //鼠标离开Text区后恢复默认形态
    }
});

// 输入变化事件 2017/3/18 19:58
txtContent.getCaret().addChangeListener(new ChangeListener() {
    public void stateChanged(ChangeEvent e) {
        txtContent.getCaret().setVisible(true);   //使Text区的文本光标显示
    }
});

JTextArea只做展示作用,这样我们的ToolWindow就创建完了。

接下来看看我们怎么去使用。

6,获取ToolWindow控件

上一篇的Dialog创建中,我们使用了回调方法【SelectCallBack.selectProject】,那我们就在这里面将ToolWindow控件拿出来,并找出JTextArea子控件,将项目路径下的所有文件路径展示出来,代码如下:

// 找出当前统计的项目 2017/3/18 19:59
Project project = null;
for (int i = 0; i < projects.length; i++) {
    if (path.equals(projects[i].getBasePath())) {
        project = projects[i];
        break;
    }
}

// 找出统计文件 2017/3/18 19:59
if (project != null) {

    // 将项目对象,ToolWindow的id传入,获取控件对象
    ToolWindow toolWindow = ToolWindowManager.getInstance(project).getToolWindow("Compute Code Lines");
    if (toolWindow != null) {

        // 无论当前状态为关闭/打开,进行强制打开ToolWindow 2017/3/21 16:21
        toolWindow.show(new Runnable() {
            @Override
            public void run() {

            }
        });

        // ToolWindow未初始化时,可能为空 2017/4/4 18:20
        try {
            jTextArea = (JTextArea) ((JScrollPane)toolWindow.getContentManager().getContent(0)
                    .getComponent().getComponent(0)).getViewport().getComponent(0);
            if (jTextArea != null) {
                jTextArea.append("开始统计,项目路径为:\"" + path + "\".\n");
                _getFiles(path);
            }
        } catch (Exception e1) { }
    }
}

PS:

1),首先获取当前的项目;
2),使用ToolWindowManager,将项目对象、ToolWindow的id传入,获取控件对象;
3),使用toolWindow.show强制打开;
4),从getContentManager获取Content,再获取其中的Component,转换成我们上面添加的JScrollPane后,从getViewport中获取我们的JTextArea;
5),获取JTextArea时,切记一定要判断是否为空,因为在Android Studio使用该插件时,是不会自动初始化的。

这里有点尴尬,我也不懂Swing,不知道更方便的做法是什么,如果有熟悉的朋友,请留言指导一下。

演示效果图,如下:

ToolWindow效果图

好了,到这里ToolWindow的创建与使用就告一段落了,详细请见官方文档--ToolWindow

这里解决的是插件问题集,第6、第9个问题,谢谢支持~~~

后续更新,继续记录解决遇到的问题!!!

上一篇下一篇

猜你喜欢

热点阅读