oracle.javatools.editor

Interface BasicEditorPaneContainer

All Known Implementing Classes:

AbstractMergeEditor, BaseMergeEditor, BaseTextMergeEditor, CodeEditor, DynamicMergeEditor, oracle.jdevimpl.history.HistoryViewer, TextMergeEditor, VersionHistoryViewer

public interface BasicEditorPaneContainer

A marker interface to indicate a class has a BasicEditorPane contained within it, and a method to retrieve it.

It is used by Editors to allow controllers to access the actual BasicEditorPane component.

A container could potentially contain more than one editor, it is up to the implementor to decide which one to return. This return value need not be consistent, e.g. a different editor might be returned if the focus changes between two contained editors

Method Summary

Modifier and Type	Method and Description
BasicEditorPane	getFocusedEditorPane() Fetches the focused (active) editor pane embedded in the editor.

Method Detail

getFocusedEditorPane

BasicEditorPane getFocusedEditorPane()

Fetches the focused (active) editor pane embedded in the editor. If there is more than one editor pane, the one with focus should be returned. If the focus is not currently on an editor pane, then null should be returned.

Returns:

the instance of the embedded BasicEditorPane that currently has focus