Package com.intellij.openapi.wm

Interface StatusBarWidgetFactory

All Known Implementing Classes:

CodeStyleStatusBarWidgetFactory, ColumnSelectionModeWidgetFactory, EncodingPanelWidgetFactory, FatalErrorWidgetFactory, GitBranchWidget.Factory, HgStatusWidget.Factory, InspectionProfileWidgetFactory, JsonSchemaStatusWidgetFactory, LineSeparatorWidgetFactory, MemoryIndicatorWidgetFactory, NotificationWidgetFactory, PositionPanelWidgetFactory, ReadOnlyAttributeWidgetFactory, StatusBarEditorBasedWidgetFactory, StatusBarWidgetProviderToFactoryAdapter, WriteThreadIndicatorWidgetFactory

public interface StatusBarWidgetFactory

Extension point for adding user-configurable widgets to the status bar. By default, a widget would be available only in the main IDE, but not in Light Edit. In order to make the widget available in Light Edit, the factory should implement LightEditCompatible. Prohibiting the widget for the main IDE could be done in the isAvailable(Project) method.

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<StatusBarWidgetFactory>	EP_NAME

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)
java.lang.String	getDisplayName()
java.lang.String	getId()
boolean	isAvailable(Project project) Returns availability of widget.
default boolean	isConfigurable()
default boolean	isEnabledByDefault()

Field Detail

EP_NAME

static final ExtensionPointName<StatusBarWidgetFactory> EP_NAME

Method Detail

getId

java.lang.String getId()

Returns:

Widget identifier. Used to store visibility settings.

getDisplayName

java.lang.String getDisplayName()

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

boolean isAvailable(Project project)

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.

createWidget

StatusBarWidget createWidget(Project project)

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 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.

disposeWidget

void disposeWidget(StatusBarWidget widget)

canBeEnabledOn

boolean canBeEnabledOn(StatusBar statusBar)

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

isEnabledByDefault

default boolean isEnabledByDefault()

Returns:

true if the widget should be created by default. Otherwise, the user must enable it explicitly via status bar context menu or settings.

isConfigurable

default boolean isConfigurable()

Returns:

Returns whether the user should be able to enable or disable the widget.

Some widgets are controlled by application-level settings (e.g., Memory indicator) or cannot be disabled (e.g., Write thread indicator) and thus shouldn't be configurable via status bar context menu or settings.