|
Eclipse Platform Release 3.7 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.core.commands.common.EventManager
org.eclipse.ui.part.WorkbenchPart
org.eclipse.ui.part.EditorPart
org.eclipse.ui.part.MultiPageEditorPart
org.eclipse.ui.forms.editor.FormEditor
org.eclipse.ui.forms.editor.SharedHeaderFormEditor
public abstract class SharedHeaderFormEditor
A variation of FormEditor, this editor has a stable header that does
not change when pages are switched. Pages that are added to this editor
should not have the title or image set.
| Field Summary |
|---|
| Fields inherited from class org.eclipse.ui.forms.editor.FormEditor |
|---|
pages |
| Fields inherited from class org.eclipse.ui.part.MultiPageEditorPart |
|---|
PAGE_CONTAINER_SITE |
| Fields inherited from interface org.eclipse.ui.IEditorPart |
|---|
PROP_DIRTY, PROP_INPUT |
| Fields inherited from interface org.eclipse.ui.IWorkbenchPart |
|---|
PROP_TITLE |
| Constructor Summary | |
|---|---|
SharedHeaderFormEditor()
The default constructor. |
|
| Method Summary | |
|---|---|
protected void |
commitPages(boolean onSave)
Commits all dirty pages in the editor. |
protected void |
createHeaderContents(IManagedForm headerForm)
Subclasses should extend this method to configure the form that owns the shared header. |
protected Composite |
createPageContainer(Composite parent)
Overrides super to create a form in which to host the tab
folder. |
protected void |
createPages()
Creates the common toolkit for this editor and adds pages to the editor. |
void |
dispose()
Disposes the pages and the toolkit after disposing the editor itself. |
IManagedForm |
getHeaderForm()
Returns the form that owns the shared header. |
boolean |
isDirty()
Tests whether the editor is dirty by checking all the pages that implement IFormPage. |
protected void |
setActivePage(int pageIndex)
Sets the currently active page. |
void |
setFocus()
The MultiPageEditor implementation of this
IWorkbenchPart method sets focus on the active nested
editor, if there is one. |
| Methods inherited from class org.eclipse.ui.forms.editor.FormEditor |
|---|
addPage, addPage, addPage, addPage, addPage, addPage, addPages, close, configurePage, createToolkit, editorDirtyStateChanged, findPage, getActiveEditor, getActivePageInstance, getCurrentPage, getSelectedPage, getToolkit, init, pageChange, removePage, selectReveal, setActivePage, setActivePage, updateActionBarContributor |
| Methods inherited from class org.eclipse.ui.part.MultiPageEditorPart |
|---|
activateSite, addPageChangedListener, createPartControl, createSite, deactivateSite, findEditors, getActivePage, getAdapter, getContainer, getControl, getEditor, getPageCount, getPageImage, getPageSite, getPageText, handlePropertyChange, initializePageSwitching, removePageChangedListener, setActiveEditor, setControl, setPageImage, setPageText |
| Methods inherited from class org.eclipse.ui.part.EditorPart |
|---|
checkSite, doSave, doSaveAs, getEditorInput, getEditorSite, getTitleToolTip, isSaveAsAllowed, isSaveOnCloseNeeded, setContentDescription, setInitializationData, setInput, setInputWithNotify, setPartName |
| Methods inherited from class org.eclipse.ui.part.WorkbenchPart |
|---|
addPartPropertyListener, addPropertyListener, firePartPropertyChanged, firePropertyChange, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, removePartPropertyListener, removePropertyListener, setPartProperty, setSite, setTitle, setTitleImage, setTitleToolTip, showBusy |
| Methods inherited from class org.eclipse.core.commands.common.EventManager |
|---|
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface org.eclipse.ui.IWorkbenchPart |
|---|
addPropertyListener, getSite, getTitle, getTitleImage, removePropertyListener |
| Constructor Detail |
|---|
public SharedHeaderFormEditor()
| Method Detail |
|---|
protected Composite createPageContainer(Composite parent)
super to create a form in which to host the tab
folder. This form will be responsible for creating a common form header.
Child pages should not have a header of their own.
createPageContainer in class FormEditorparent - the page container parent
null.MultiPageEditorPart.createPageContainer(org.eclipse.swt.widgets.Composite)public IManagedForm getHeaderForm()
protected void createPages()
FormEditor
createPages in class FormEditorFormEditor.addPages()protected void setActivePage(int pageIndex)
MultiPageEditorPart
setActivePage in class FormEditorpageIndex - the index of the page to be activated; the index must be validMultiPageEditorPart.setActivePage(int)public void setFocus()
MultiPageEditorPartMultiPageEditor implementation of this
IWorkbenchPart method sets focus on the active nested
editor, if there is one.
Subclasses may extend or reimplement.
setFocus in interface IWorkbenchPartsetFocus in class MultiPageEditorPartpublic void dispose()
FormEditor
dispose in interface IWorkbenchPartdispose in class FormEditorpublic boolean isDirty()
FormEditorIFormPage. If none of them is dirty, the method
delegates further processing to super.isDirty().
isDirty in interface ISaveablePartisDirty in class FormEditortrue if any of the pages in the editor are dirty,
false otherwise.protected void commitPages(boolean onSave)
FormEditor
commitPages in class FormEditoronSave - true if commit is performed as part
of the 'save' operation, false otherwise.protected void createHeaderContents(IManagedForm headerForm)
headerForm - the form that owns the shared headerIFormPart
|
Eclipse Platform Release 3.7 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2011. All rights reserved.