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

Class InspectionProfileWidgetFactory

java.lang.Object

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

com.intellij.openapi.wm.impl.status.InspectionProfileWidgetFactory

All Implemented Interfaces:

StatusBarWidgetFactory

public class InspectionProfileWidgetFactory
extends StatusBarEditorBasedWidgetFactory

Field Summary

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

EP_NAME

Constructor Summary

Constructors

Constructor and Description
InspectionProfileWidgetFactory()

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class com.intellij.openapi.wm.impl.status.widget.StatusBarEditorBasedWidgetFactory

canBeEnabledOn, getFileEditor, getTextEditor

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

isConfigurable, isEnabledByDefault

Constructor Detail

InspectionProfileWidgetFactory

public InspectionProfileWidgetFactory()

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

Overrides:

isAvailable in class StatusBarEditorBasedWidgetFactory

getId

public java.lang.String getId()

Returns:

Widget identifier. Used to store visibility settings.

getDisplayName

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

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.

disposeWidget

public void disposeWidget(StatusBarWidget widget)