Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> eclipse >> ui >> [ internal overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.eclipse.ui.internal
Class EditorAreaHelper  

java.lang.Object
  org.eclipse.ui.internal.EditorAreaHelper

---

public class EditorAreaHelper

extends java.lang.Object

EditorAreaHelper is a wrapper for PartTabworkbook.

---

Field Summary
private  EditorSashContainer	editorArea
private  java.util.ArrayList	editorTable
private  org.eclipse.ui.commands.HandlerSubmission	openEditorDropDownHandlerSubmission
private  WorkbenchPage	page

 

Constructor Summary

EditorAreaHelper(WorkbenchPage page)           Creates a new EditorAreaHelper.

 

Method Summary
void	closeAllEditors()           Closes all of the editors.
private  void	closeEditor(EditorPane pane)           Closes an editor.
void	closeEditor(org.eclipse.ui.IEditorPart part)           Closes an editor.
void	closeEditor(org.eclipse.ui.IEditorReference ref)           Closes an editor.
static void	derefPart(LayoutPart part)           Deref a given part.
void	displayEditorList()           Displays a list of open editors
void	dispose()           Dispose of the editor presentation.
void	fixVisibleEditor()           The active editor has failed to be restored.
java.lang.String	getActiveEditorWorkbookID()
org.eclipse.ui.IEditorReference[]	getEditors()           Returns an array of the open editors.
LayoutPart	getLayoutPart()           Returns the editor area.
org.eclipse.ui.IEditorReference	getVisibleEditor()           Returns the active editor in this perspective.
java.util.ArrayList	getWorkbooks()           Method getWorkbooks.
private  EditorPane	initPane(EditorPane pane, org.eclipse.ui.IEditorReference ref)
void	moveEditor(org.eclipse.ui.IEditorPart part, int position)
void	openEditor(org.eclipse.ui.IEditorReference ref, boolean setVisible)           Opens an editor within the presentation but does not give it focus.
void	openEditor(org.eclipse.ui.IEditorReference ref, org.eclipse.ui.IEditorReference[] innerEditors, boolean setVisible)           Opens an editor within the presentation but does not give it focus.
org.eclipse.core.runtime.IStatus	restorePresentationState(org.eclipse.ui.IMemento areaMem)           Restore the presentation
org.eclipse.core.runtime.IStatus	restoreState(org.eclipse.ui.IMemento memento)
org.eclipse.core.runtime.IStatus	saveState(org.eclipse.ui.IMemento memento)
void	setActiveEditorWorkbookFromID(java.lang.String id)
boolean	setVisibleEditor(org.eclipse.ui.IEditorReference ref, boolean setFocus)           Brings an editor to the front and optionally gives it focus.
void	showVisibleEditor()           Makes sure the visible editor's tab is visible.

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

page

private WorkbenchPage page

---

editorTable

private java.util.ArrayList editorTable

---

editorArea

private EditorSashContainer editorArea

---

openEditorDropDownHandlerSubmission

private org.eclipse.ui.commands.HandlerSubmission openEditorDropDownHandlerSubmission

Constructor Detail

EditorAreaHelper

public EditorAreaHelper(WorkbenchPage page)

Creates a new EditorAreaHelper.

Method Detail

displayEditorList

public void displayEditorList()

Displays a list of open editors

---

closeAllEditors

public void closeAllEditors()

Closes all of the editors.

---

closeEditor

public void closeEditor(org.eclipse.ui.IEditorReference ref)

Closes an editor.

---

closeEditor

public void closeEditor(org.eclipse.ui.IEditorPart part)

Closes an editor.

---

closeEditor

private void closeEditor(EditorPane pane)

Closes an editor.

---

derefPart

public static void derefPart(LayoutPart part)

Deref a given part. Deconstruct its container as required. Do not remove drag listeners.

---

dispose

public void dispose()

Dispose of the editor presentation.

---

getActiveEditorWorkbookID

public java.lang.String getActiveEditorWorkbookID()

---

getEditors

public org.eclipse.ui.IEditorReference[] getEditors()

Returns an array of the open editors.

---

getLayoutPart

public LayoutPart getLayoutPart()

Returns the editor area.

---

getVisibleEditor

public org.eclipse.ui.IEditorReference getVisibleEditor()

Returns the active editor in this perspective. If the editors appear in a workbook this will be the visible editor. If the editors are scattered around the workbench this will be the most recent editor to hold focus.

---

fixVisibleEditor

public void fixVisibleEditor()

The active editor has failed to be restored. Find another editor, restore it and make it visible.

---

moveEditor

public void moveEditor(org.eclipse.ui.IEditorPart part,
                       int position)

---

openEditor

public void openEditor(org.eclipse.ui.IEditorReference ref,
                       org.eclipse.ui.IEditorReference[] innerEditors,
                       boolean setVisible)

Opens an editor within the presentation but does not give it focus.

---

openEditor

public void openEditor(org.eclipse.ui.IEditorReference ref,
                       boolean setVisible)

Opens an editor within the presentation but does not give it focus.

---

initPane

private EditorPane initPane(EditorPane pane,
                            org.eclipse.ui.IEditorReference ref)

---

restoreState

public org.eclipse.core.runtime.IStatus restoreState(org.eclipse.ui.IMemento memento)

---

restorePresentationState

public org.eclipse.core.runtime.IStatus restorePresentationState(org.eclipse.ui.IMemento areaMem)

Restore the presentation

---

saveState

public org.eclipse.core.runtime.IStatus saveState(org.eclipse.ui.IMemento memento)

---

setActiveEditorWorkbookFromID

public void setActiveEditorWorkbookFromID(java.lang.String id)

---

showVisibleEditor

public void showVisibleEditor()

Makes sure the visible editor's tab is visible.

---

setVisibleEditor

public boolean setVisibleEditor(org.eclipse.ui.IEditorReference ref,
                                boolean setFocus)

Brings an editor to the front and optionally gives it focus.

---

getWorkbooks

public java.util.ArrayList getWorkbooks()

Method getWorkbooks.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> eclipse >> ui >> [ internal overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---