Package com.intellij.openapi.wm.impl.status.widget

Class StatusBarWidgetProviderToFactoryAdapter

java.lang.Object

com.intellij.openapi.wm.impl.status.widget.StatusBarWidgetProviderToFactoryAdapter

All Implemented Interfaces:

StatusBarWidgetFactory

public final class StatusBarWidgetProviderToFactoryAdapter
extends java.lang.Object
implements StatusBarWidgetFactory

Field Summary

Fields inherited from interface com.intellij.openapi.wm.StatusBarWidgetFactory

EP_NAME

Constructor Summary

Constructors

Constructor and Description
StatusBarWidgetProviderToFactoryAdapter(Project project, StatusBarWidgetProvider provider)

Method Summary

Modifier and Type	Method and Description
boolean	canBeEnabledOn(StatusBar statusBar)
StatusBarWidget	createWidget(Project project) Creates a widget to be added to the status bar.
void	disposeWidget(StatusBarWidget widget)
boolean	equals(java.lang.Object o)
java.lang.String	getAnchor()
java.lang.String	getDisplayName()
java.lang.String	getId()
int	hashCode()
boolean	isAvailable(Project project) Returns availability of widget.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.intellij.openapi.wm.StatusBarWidgetFactory

isConfigurable, isEnabledByDefault

Constructor Detail

StatusBarWidgetProviderToFactoryAdapter

public StatusBarWidgetProviderToFactoryAdapter(Project project,
                                               StatusBarWidgetProvider provider)

Method Detail

getId

public java.lang.String getId()

Specified by:

getId in interface StatusBarWidgetFactory

Returns:

Widget identifier. Used to store visibility settings.

getDisplayName

public java.lang.String getDisplayName()

Specified by:

getDisplayName in interface StatusBarWidgetFactory

Returns:

Widget's display name. Used to refer a widget in UI, e.g. for "Enable/disable <display name>" action names or for checkbox texts in settings.

isAvailable

public boolean isAvailable(Project project)

Description copied from interface: StatusBarWidgetFactory

Returns availability of widget.

`False` means that IDE won't try to create a widget or will dispose it on StatusBarWidgetsManager.updateWidget(java.lang.Class<? extends com.intellij.openapi.wm.StatusBarWidgetFactory>) call.

E.g. `false` can be returned for

• notifications widget if Event log is shown as a tool window
• memory indicator widget if it is disabled in the appearance settings
• git widget if there are no git repos in a project

Whenever availability is changed, you need to call StatusBarWidgetsManager.updateWidget(StatusBarWidgetFactory) explicitly to get status bar updated.

Specified by:

isAvailable in interface StatusBarWidgetFactory

canBeEnabledOn

public boolean canBeEnabledOn(StatusBar statusBar)

Specified by:

canBeEnabledOn in interface StatusBarWidgetFactory

Returns:

Returns whether the widget can be enabled on the given status bar right now. Status bar's context menu with enable/disable action depends on the result of this method.

It's better to have this method aligned with EditorBasedStatusBarPopup.WidgetState.HIDDEN, whenever state is HIDDEN, this method should return false. Otherwise enabling widget via context menu won't take any visual effect.

E.g. EditorBasedWidget are available if editor is opened in a frame that given status bar is attached to

For creating editor based widgets see also StatusBarEditorBasedWidgetFactory

createWidget

public StatusBarWidget createWidget(Project project)

Description copied from interface: StatusBarWidgetFactory

Creates a widget to be added to the status bar.

Once the method is invoked on project initialization, the widget won't be recreated or disposed implicitly.

You may need to recreate it if:

its availability has changed. See StatusBarWidgetFactory.isAvailable(Project) its visibility has changed. See com.intellij.openapi.wm.impl.status.widget.StatusBarWidgetSettings

To do this, you need to explicitly invoke StatusBarWidgetsManager.updateWidget(StatusBarWidgetFactory) to recreate the widget and re-add it to the status bar.

Specified by:

createWidget in interface StatusBarWidgetFactory

disposeWidget

public void disposeWidget(StatusBarWidget widget)

Specified by:

disposeWidget in interface StatusBarWidgetFactory

getAnchor

public java.lang.String getAnchor()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object