com.intellij.openapi.wm.ToolWindowFactory.java Source code

Introduction

Here is the source code for com.intellij.openapi.wm.ToolWindowFactory.java

Source

// Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
package com.intellij.openapi.wm;

import com.intellij.openapi.project.Project;
import org.jetbrains.annotations.NotNull;

/**
 * Performs lazy initialization of a tool window registered in {@code plugin.xml}.
 * Please implement {@link com.intellij.openapi.project.DumbAware} marker interface to indicate that the tool window content should be
 * available during the indexing process.
 *
 * @author yole
 * @author Konstantin Bulenkov
 * @see ToolWindowEP
 */
public interface ToolWindowFactory {
    default boolean isApplicable(@NotNull Project project) {
        return true;
    }

    void createToolWindowContent(@NotNull Project project, @NotNull ToolWindow toolWindow);

    /**
     * Perform additional initialization routine here.
     */
    default void init(@NotNull ToolWindow toolWindow) {
    }

    /**
     * Check if tool window (and its stripe button) should be visible after startup.
     *
     * @see ToolWindow#isAvailable()
     */
    default boolean shouldBeAvailable(@NotNull Project project) {
        return true;
    }

    /**
     * @deprecated Use {@link ToolWindowEP#isDoNotActivateOnStart}
     * @return
     */
    @Deprecated
    default boolean isDoNotActivateOnStart() {
        return false;
    }
}