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

Class StatusBarEditorBasedWidgetFactory

java.lang.Object

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

All Implemented Interfaces:

StatusBarWidgetFactory

Direct Known Subclasses:

CodeStyleStatusBarWidgetFactory, ColumnSelectionModeWidgetFactory, EncodingPanelWidgetFactory, InspectionProfileWidgetFactory, JsonSchemaStatusWidgetFactory, LineSeparatorWidgetFactory, PositionPanelWidgetFactory, ReadOnlyAttributeWidgetFactory

public abstract class StatusBarEditorBasedWidgetFactory
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
StatusBarEditorBasedWidgetFactory()

Method Summary

Modifier and Type	Method and Description
boolean	canBeEnabledOn(StatusBar statusBar)
protected FileEditor	getFileEditor(StatusBar statusBar)
protected Editor	getTextEditor(StatusBar statusBar)
boolean	isAvailable(Project project) Returns availability of widget.

Methods inherited from class java.lang.Object

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

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

createWidget, disposeWidget, getDisplayName, getId, isConfigurable, isEnabledByDefault

Constructor Detail

StatusBarEditorBasedWidgetFactory

public StatusBarEditorBasedWidgetFactory()

Method Detail

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

getFileEditor

protected FileEditor getFileEditor(StatusBar statusBar)

getTextEditor

protected Editor getTextEditor(StatusBar statusBar)