oracle.ide

Interface TitleProvider

public interface TitleProvider

A product may provide a TitleProvider implementation to provide a custom title for the main window.

The getTitle(View) method will be called each time an event occurs that invalidates the main window title. Products and extensions may also force an update of the titlebar by calling IdeMainWindow.updateTitle().

Implementations should take care to avoid doing expensive lookup in the getTitle(View) method. The title may be refreshed very frequently.

Generally an implementation of this interface will use the IdeMainWindow.getMainTitle() method to get the first part of the titlebar text, then append to it some view or context specific information. However, this is not required.

Products register TitleProvider implementations as part of the <product-hook> in the product extension manifest. A default provider is always present in the base IDE which includes the active workspace, active project and file being edited (if any).

Since:

11.0

Method Summary

Modifier and Type	Method and Description
java.lang.String	getTitle(View activeView) Returns the titlebar text to use.

Method Detail

getTitle

java.lang.String getTitle(View activeView)

Returns the titlebar text to use.

Parameters:

activeView - the active view at the time the request to update the title was received. May be null.

Returns:

the new text for the title. May be null, in which case the title will be set to the empty string.