oracle.ide.editor
Interface EditorFrame

All Superinterfaces:

ControllerProvider, Helpable, Observer, View

public interface EditorFrame

extends View, Observer

The EditorFrame interface.

Field Summary

static java.lang.String

EDITOR_FRAME_ID Constant used for constructing a ViewId.

Fields inherited from interface oracle.ide.addin.View

PROJECT_PROP, VISIBLE_PROP, WORKSPACE_PROP

Method Summary

boolean	activateEditor(Editor editor) Activates the given editor and raises it to the front.
void	addViewSelectionListener(ViewSelectionListener listener) Adds the specified listener as one of our ViewSelctionListeners.
void	closeAll()
void	closeEditor(Editor editor) Closes the editor and removes the tab from the frame.
void	displayEditorAsStale(Editor editor) Display a glass pane over the given Editor such that the user is provided with a visual cue that that Editor is out of date and is prevented from interacting with it.
Editor	getCurrentEditor() Fetches the current editor whose tab is selected in this frame.
Editor	getEditor(int index) Fetches the Editor instance at the given index in our tabbed pane
Editor	getEditorBySelOrder(int index) Fetches the Editor instance at the given index in our tabbed pane
int	getEditorCount() Returns the number of opened editors in this editor frame.
boolean	isSelected() Returns whether the EditorFrame is the currently "selected" or active frame.
void	removeViewSelectionListener(ViewSelectionListener listener) Removes the specified listener from being one of our ViewSelctionListeners.

Methods inherited from interface oracle.ide.addin.View

activate, addViewListener, close, deactivate, getContext, getContext, getContextMenu, getGUI, getId, getSelection, getToolbar, isVisible, owner, removeViewListener, setToolbarVisible, show, updateTitle, updateVisibleActions

Methods inherited from interface oracle.ide.addin.ControllerProvider

getController

Methods inherited from interface oracle.ide.help.Helpable

getHelpInfo

Methods inherited from interface oracle.ide.addin.Observer

update

Field Detail

EDITOR_FRAME_ID

public static final java.lang.String EDITOR_FRAME_ID

Constant used for constructing a ViewId.

See Also:

Constant Field Values

Method Detail

isSelected

public boolean isSelected()

Returns whether the EditorFrame is the currently "selected" or active frame.

activateEditor

public boolean activateEditor(Editor editor)

Activates the given editor and raises it to the front.

Parameters:

editor - the editor to activate

Returns:

true if the editor was succesfully activated

getEditorCount

public int getEditorCount()

Returns the number of opened editors in this editor frame.

Returns:

the count of editors

getEditor

public Editor getEditor(int index)

Fetches the Editor instance at the given index in our tabbed pane

Parameters:

index - the index of the Editor instance to fetch in our tabbed pane

Returns:

the requested Editor instance

getEditorBySelOrder

public Editor getEditorBySelOrder(int index)

Fetches the Editor instance at the given index in our tabbed pane

Parameters:

index - the selection index of the Editor instance. Active editor is at 0, last before is 1, ...

Returns:

the requested Editor instance

getCurrentEditor

public Editor getCurrentEditor()

Fetches the current editor whose tab is selected in this frame.

Returns:

the current selected Editor

closeEditor

public void closeEditor(Editor editor)

Closes the editor and removes the tab from the frame. This should be used to close and free up the resources used by the editor.

Parameters:

editor - the editor to close

closeAll

public void closeAll()

displayEditorAsStale

public void displayEditorAsStale(Editor editor)

Display a glass pane over the given Editor such that the user is provided with a visual cue that that Editor is out of date and is prevented from interacting with it.

addViewSelectionListener

public void addViewSelectionListener(ViewSelectionListener listener)

Adds the specified listener as one of our ViewSelctionListeners.

Specified by:

addViewSelectionListener in interface View

Parameters:

listener - the listener to add

removeViewSelectionListener

public void removeViewSelectionListener(ViewSelectionListener listener)

Removes the specified listener from being one of our ViewSelctionListeners.

Specified by:

removeViewSelectionListener in interface View

Parameters:

listener - the listener to remove