Package com.intellij.openapi.wm

Interface ToolWindowFactory

All Known Subinterfaces:

ToolWindowFactoryEx

All Known Implementing Classes:

AbstractExternalSystemToolWindowFactory, CommanderToolWindowFactory, EventLogToolWindowFactory, EventsWatcherToolWindowFactory, GradleToolWindowFactory, MvcToolWindowDescriptor, ProblemsViewToolWindowFactory, ProjectViewToolWindowFactory, RunDashboardToolWindowFactory, ServiceViewToolWindowFactory, TerminalToolWindowFactory, TodoToolWindowFactory

public interface ToolWindowFactory

Performs lazy initialization of a tool window registered in plugin.xml. Please implement DumbAware marker interface to indicate that the tool window content should be available during the indexing process.

To localize tool window stripe title, add key toolwindow.stripe.yourToolWindowId.replace(" ", "_") to plugin's resource bundle.

See https://www.jetbrains.org/intellij/sdk/docs/user_interface_components/tool_windows.html

Method Summary

Modifier and Type	Method and Description
void	createToolWindowContent(Project project, ToolWindow toolWindow)
default void	init(ToolWindow toolWindow) Perform additional initialization routine here.
default boolean	isApplicable(Project project)
default boolean	isDoNotActivateOnStart() Deprecated. Use ToolWindowEP.isDoNotActivateOnStart
default boolean	shouldBeAvailable(Project project) Check if tool window (and its stripe button) should be visible after startup.

Method Detail

isApplicable

default boolean isApplicable(Project project)

createToolWindowContent

void createToolWindowContent(Project project,
                             ToolWindow toolWindow)

init

default void init(ToolWindow toolWindow)

Perform additional initialization routine here.

shouldBeAvailable

default boolean shouldBeAvailable(Project project)

Check if tool window (and its stripe button) should be visible after startup.

See Also:

ToolWindow.isAvailable()

isDoNotActivateOnStart

@Deprecated
default boolean isDoNotActivateOnStart()

Deprecated. Use ToolWindowEP.isDoNotActivateOnStart

Returns: