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

Class LineSeparatorWidgetFactory

java.lang.Object

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

com.intellij.openapi.wm.impl.status.LineSeparatorWidgetFactory

All Implemented Interfaces:

StatusBarWidgetFactory

public class LineSeparatorWidgetFactory
extends StatusBarEditorBasedWidgetFactory

Field Summary

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

EP_NAME

Constructor Summary

Constructors

Constructor and Description
LineSeparatorWidgetFactory()

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()

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

getFileEditor, getTextEditor, isAvailable

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

LineSeparatorWidgetFactory

public LineSeparatorWidgetFactory()

Method Detail

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)

canBeEnabledOn

public boolean canBeEnabledOn(StatusBar statusBar)

Specified by:

canBeEnabledOn in interface StatusBarWidgetFactory

Overrides:

canBeEnabledOn in class StatusBarEditorBasedWidgetFactory

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