Package com.intellij.openapi.wm

Interface ToolWindow

All Known Subinterfaces:

ToolWindowEx

All Known Implementing Classes:

ToolWindowHeadlessManagerImpl.MockToolWindow

public interface ToolWindow

Tool windows expose UI for specific functionality, like "Project" or "Favorites".

See Also:

ToolWindowEP

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ToolWindow.Border

Field Summary

Fields

Modifier and Type	Field and Description
static Key<java.lang.Boolean>	SHOW_CONTENT_ICON

Method Summary

Modifier and Type	Method and Description
void	activate(java.lang.Runnable runnable)
void	activate(java.lang.Runnable runnable, boolean autoFocusContents)
void	activate(java.lang.Runnable runnable, boolean autoFocusContents, boolean forced)
void	addContentManagerListener(ContentManagerListener listener)
default ActionCallback	getActivation() Deprecated. Not used anymore.
ToolWindowAnchor	getAnchor()
javax.swing.JComponent	getComponent()
ContentManager	getContentManager()
ContentManager	getContentManagerIfCreated()
ToolWindowContentUiType	getContentUiType()
Disposable	getDisposable()
default java.lang.String	getHelpId()
javax.swing.Icon	getIcon()
java.lang.String	getId()
java.lang.String	getStripeTitle()
java.lang.String	getTitle()
ToolWindowType	getType()
default void	hide()
void	hide(java.lang.Runnable runnable) Hides tool window.
void	installWatcher(ContentManager contentManager)
boolean	isActive()
boolean	isAutoHide()
boolean	isAvailable()
boolean	isDisposed()
boolean	isShowStripeButton()
boolean	isSplitMode()
boolean	isVisible()
void	remove() Delete tool window.
void	setAnchor(ToolWindowAnchor anchor, java.lang.Runnable runnable)
void	setAutoHide(boolean value)
void	setAvailable(boolean value)
void	setAvailable(boolean value, java.lang.Runnable runnable) Sets whether the tool window available or not.
void	setContentUiType(ToolWindowContentUiType type, java.lang.Runnable runnable)
void	setDefaultContentUiType(ToolWindowContentUiType type)
void	setDefaultState(ToolWindowAnchor anchor, ToolWindowType type, java.awt.Rectangle floatingBounds)
default void	setHelpId(java.lang.String helpId)
void	setIcon(javax.swing.Icon icon) Sets new window icon.
void	setShowStripeButton(boolean value)
void	setSplitMode(boolean split, java.lang.Runnable runnable) There are four base anchors for Tool Window: TOP, LEFT, BOTTOM, RIGHT.
void	setStripeTitle(java.lang.String title) Sets new window stripe button text.
void	setTitle(java.lang.String title) Sets new window title.
void	setToHideOnEmptyContent(boolean hideOnEmpty)
void	setType(ToolWindowType type, java.lang.Runnable runnable)
default void	show()
void	show(java.lang.Runnable runnable)
void	showContentPopup(java.awt.event.InputEvent inputEvent)

Field Detail

SHOW_CONTENT_ICON

static final Key<java.lang.Boolean> SHOW_CONTENT_ICON

Method Detail

getId

java.lang.String getId()

isActive

boolean isActive()

Throws:

java.lang.IllegalStateException - if tool window isn't installed.

activate

void activate(java.lang.Runnable runnable)

Parameters:

runnable - A command to execute right after the window gets activated. The call is asynchronous since it may require animation.

Throws:

java.lang.IllegalStateException - if tool window isn't installed.

activate

void activate(java.lang.Runnable runnable,
              boolean autoFocusContents)

activate

void activate(java.lang.Runnable runnable,
              boolean autoFocusContents,
              boolean forced)

isVisible

boolean isVisible()

Returns:

whether the tool window is visible or not.

Throws:

java.lang.IllegalStateException - if tool window isn't installed.

show

void show(java.lang.Runnable runnable)

Parameters:

runnable - A command to execute right after the window shows up. The call is asynchronous since it may require animation.

Throws:

java.lang.IllegalStateException - if tool window isn't installed.

show

default void show()

hide

void hide(java.lang.Runnable runnable)

Hides tool window. If the window is active, then the method deactivates it. Does nothing if tool window isn't visible.

Parameters:

runnable - A command to execute right after the window hides. The call is asynchronous since it may require animation.

Throws:

java.lang.IllegalStateException - if tool window isn't installed.

hide

default void hide()

getAnchor

ToolWindowAnchor getAnchor()

Throws:

java.lang.IllegalStateException - if tool window isn't installed.

setAnchor

void setAnchor(ToolWindowAnchor anchor,
               java.lang.Runnable runnable)

Throws:

java.lang.IllegalStateException - if tool window isn't installed.

isSplitMode

boolean isSplitMode()

Throws:

java.lang.IllegalStateException - if tool window isn't installed.

setSplitMode

void setSplitMode(boolean split,
                  java.lang.Runnable runnable)

There are four base anchors for Tool Window: TOP, LEFT, BOTTOM, RIGHT. For each anchor there are two groups tool windows - not split and split for better organizing. For example, you can see two actions in Move To group: Left Top and Left Bottom. 'Left' here is anchor or side where the button is located, 'Top' and 'Bottom' are two subsets of buttons (not split and split).

Throws:

java.lang.IllegalStateException - if tool window isn't installed.

See Also:

ToolWindowAnchor

isAutoHide

boolean isAutoHide()

Throws:

java.lang.IllegalStateException - if tool window isn't installed.

setAutoHide

void setAutoHide(boolean value)

getType

ToolWindowType getType()

Throws:

java.lang.IllegalStateException - if tool window isn't installed.

setType

void setType(ToolWindowType type,
             java.lang.Runnable runnable)

Throws:

java.lang.IllegalStateException - if tool window isn't installed.

getIcon

javax.swing.Icon getIcon()

Returns:

Window icon. Returns null if window has no icon.

setIcon

void setIcon(javax.swing.Icon icon)

Sets new window icon.

getTitle

java.lang.String getTitle()

Returns:

Window title. Returns null if window has no title.

setTitle

void setTitle(java.lang.String title)

Sets new window title.

getStripeTitle

java.lang.String getStripeTitle()

Returns:

Window stripe button text.

setStripeTitle

void setStripeTitle(java.lang.String title)

Sets new window stripe button text.

isAvailable

boolean isAvailable()

Returns:

Whether the window is available or not.

setAvailable

void setAvailable(boolean value,
                  java.lang.Runnable runnable)

Sets whether the tool window available or not. Term "available" means that tool window can be shown and it has button on tool window bar.

Throws:

java.lang.IllegalStateException - if tool window isn't installed.

setAvailable

void setAvailable(boolean value)

setContentUiType

void setContentUiType(ToolWindowContentUiType type,
                      java.lang.Runnable runnable)

setDefaultContentUiType

void setDefaultContentUiType(ToolWindowContentUiType type)

getContentUiType

ToolWindowContentUiType getContentUiType()

installWatcher

void installWatcher(ContentManager contentManager)

getComponent

javax.swing.JComponent getComponent()

Returns:

component which represents window content.

getContentManager

ContentManager getContentManager()

getContentManagerIfCreated

ContentManager getContentManagerIfCreated()

addContentManagerListener

void addContentManagerListener(ContentManagerListener listener)

setDefaultState

void setDefaultState(ToolWindowAnchor anchor,
                     ToolWindowType type,
                     java.awt.Rectangle floatingBounds)

setToHideOnEmptyContent

void setToHideOnEmptyContent(boolean hideOnEmpty)

setShowStripeButton

void setShowStripeButton(boolean value)

Parameters:

value - if false stripe button should be hidden.

isShowStripeButton

boolean isShowStripeButton()

isDisposed

boolean isDisposed()

showContentPopup

void showContentPopup(java.awt.event.InputEvent inputEvent)

getDisposable

Disposable getDisposable()

setHelpId

default void setHelpId(java.lang.String helpId)

getHelpId

default java.lang.String getHelpId()

remove

void remove()

Delete tool window.

getActivation

@Deprecated
default ActionCallback getActivation()

Deprecated. Not used anymore.