Package com.intellij.openapi.wm

Class ToolWindowEP

java.lang.Object

com.intellij.openapi.wm.ToolWindowEP

All Implemented Interfaces:

PluginAware

Direct Known Subclasses:

FacetDependentToolWindow, LibraryDependentToolWindow

public class ToolWindowEP
extends java.lang.Object
implements PluginAware

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	anchor The side of the screen on which the toolwindow is displayed ("left", "right" or "bottom").
boolean	canCloseContents
java.lang.String	conditionClass Deprecated. Implement ToolWindowFactory.isApplicable(Project) instead.
static ExtensionPointName<ToolWindowEP>	EP_NAME
java.lang.String	factoryClass The name of the class implementing ToolWindowFactory, used to create the toolwindow contents.
java.lang.String	icon The resource path of the icon displayed on the toolwindow button.
java.lang.String	id
boolean	isDoNotActivateOnStart Tool window saves its state on project close and restore on when project opens.
boolean	secondary
boolean	side

Constructor Summary

Constructors

Constructor and Description
ToolWindowEP()

Method Summary

Modifier and Type	Method and Description
Condition<Project>	getCondition() Deprecated. Do not use ToolWindowEP.
Condition<Project>	getCondition(PluginDescriptor pluginDescriptor)
java.lang.Class<? extends ToolWindowFactory>	getFactoryClass(PluginDescriptor pluginDescriptor)
PluginDescriptor	getPluginDescriptor()
ToolWindowFactory	getToolWindowFactory() Deprecated. Do not use ToolWindowEP.
ToolWindowFactory	getToolWindowFactory(PluginDescriptor pluginDescriptor)
void	setPluginDescriptor(PluginDescriptor value) Called by extensions framework when extension is loaded from plugin.xml descriptor.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EP_NAME

public static final ExtensionPointName<ToolWindowEP> EP_NAME

id

public java.lang.String id

anchor

public java.lang.String anchor

The side of the screen on which the toolwindow is displayed ("left", "right" or "bottom").

side

public boolean side

icon

public java.lang.String icon

The resource path of the icon displayed on the toolwindow button. Toolwindow icons must have the size of 13x13 pixels.

isDoNotActivateOnStart

public boolean isDoNotActivateOnStart

Tool window saves its state on project close and restore on when project opens. In some cases, it is useful to postpone its activation until the user explicitly activates it. Example: Tool Window initialization takes a huge amount of time and makes project loading slower. true if Tool Window should not be activated on start even if was opened previously. false otherwise. Please note that active (visible and focused) tool window would be activated on start in any case.

factoryClass

public java.lang.String factoryClass

The name of the class implementing ToolWindowFactory, used to create the toolwindow contents.

conditionClass

@Deprecated
public java.lang.String conditionClass

Deprecated. Implement ToolWindowFactory.isApplicable(Project) instead.

secondary

public boolean secondary

canCloseContents

public boolean canCloseContents

Constructor Detail

ToolWindowEP

public ToolWindowEP()

Method Detail

getPluginDescriptor

public final PluginDescriptor getPluginDescriptor()

setPluginDescriptor

public final void setPluginDescriptor(PluginDescriptor value)

Description copied from interface: PluginAware

Called by extensions framework when extension is loaded from plugin.xml descriptor.

If this method is implemented in a bean class extension point and it also exposes the stored plugin description via getPluginDescriptor method, you must annotate the latter with @Transient to ensure that serialization engine won't try to deserialize this property.

Specified by:

setPluginDescriptor in interface PluginAware

Parameters:

value - descriptor of the plugin that provided this particular extension.

getToolWindowFactory

@Deprecated
public ToolWindowFactory getToolWindowFactory()

Deprecated. Do not use ToolWindowEP.

getToolWindowFactory

public ToolWindowFactory getToolWindowFactory(PluginDescriptor pluginDescriptor)

getFactoryClass

public java.lang.Class<? extends ToolWindowFactory> getFactoryClass(PluginDescriptor pluginDescriptor)

getCondition

@Deprecated
public Condition<Project> getCondition()

Deprecated. Do not use ToolWindowEP.

getCondition

public Condition<Project> getCondition(PluginDescriptor pluginDescriptor)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object