org.eclipse.sphinx.emf.editors.forms.pages

Class AbstractFormPage

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.ui.part.WorkbenchPart

org.eclipse.ui.part.EditorPart

org.eclipse.ui.forms.editor.FormPage

org.eclipse.sphinx.emf.editors.forms.pages.AbstractFormPage

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.IExecutableExtension, org.eclipse.ui.forms.editor.IFormPage, org.eclipse.ui.IEditorPart, org.eclipse.ui.ISaveablePart, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.IWorkbenchPart3, org.eclipse.ui.part.IWorkbenchPartOrientation

Direct Known Subclasses:

GenericContentsTreePage

public abstract class AbstractFormPage
extends org.eclipse.ui.forms.editor.FormPage

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.ui.IPropertyListener	inputChangeListener
protected org.eclipse.core.commands.operations.IOperationHistoryListener	operationHistoryListener
protected org.eclipse.jface.dialogs.IPageChangedListener	pageChangedListener
protected java.lang.Object	pageInput
protected IValidationProblemMarkersChangeListener	validationProblemMarkersChangeListener

Fields inherited from interface org.eclipse.ui.IEditorPart

PROP_DIRTY, PROP_INPUT

Fields inherited from interface org.eclipse.ui.IWorkbenchPart

PROP_TITLE

Constructor Summary

Constructors

Constructor and Description
AbstractFormPage(org.eclipse.ui.forms.editor.FormEditor editor, java.lang.String title)
AbstractFormPage(org.eclipse.ui.forms.editor.FormEditor editor, java.lang.String id, java.lang.String title)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addSection(IFormSection section)
protected boolean	canCreateFormContent()
protected org.eclipse.jface.viewers.IContentProvider	createContentProvider()
protected void	createFormContent(org.eclipse.ui.forms.IManagedForm managedForm)
protected org.eclipse.jface.viewers.IBaseLabelProvider	createLabelProvider()
void	dispose()
protected abstract void	doCreateFormContent(org.eclipse.ui.forms.IManagedForm managedForm)
protected void	doRefreshMessages(org.eclipse.ui.forms.IMessageManager messageManager, java.util.Map<org.eclipse.emf.ecore.EStructuralFeature,java.util.Set<IFormMessage>> messages)
protected void	doRefreshPage()
IFormSection	getActiveSection()
org.eclipse.jface.viewers.IContentProvider	getContentProvider()
java.util.List<IFormSection>	getFormSections() Deprecated. Use getSections() instead.
org.eclipse.emf.edit.provider.AdapterFactoryItemDelegator	getItemDelegator()
org.eclipse.jface.viewers.IBaseLabelProvider	getLabelProvider()
protected java.lang.Object	getPageInputFromEditor()
java.util.List<IFormSection>	getSections() Returns the list of sections added to this page by calling addSection(IFormSection)
BasicTransactionalFormEditor	getTransactionalFormEditor()
boolean	isEmpty()
protected void	refreshMessages()
protected void	refreshPage()
void	setActiveSection(IFormSection section) Sets the active section on this page.
protected void	setPageInput(java.lang.Object pageInput)

Methods inherited from class org.eclipse.ui.forms.editor.FormPage

canLeaveThePage, createPartControl, doSave, doSaveAs, getEditor, getId, getIndex, getManagedForm, getPartControl, getTitleImage, init, initialize, isActive, isDirty, isEditor, isSaveAsAllowed, selectReveal, setActive, setFocus, setIndex

Methods inherited from class org.eclipse.ui.part.EditorPart

checkSite, getEditorInput, getEditorSite, getTitleToolTip, isSaveOnCloseNeeded, setContentDescription, setInitializationData, setInput, setInputWithNotify, setPartName

Methods inherited from class org.eclipse.ui.part.WorkbenchPart

addPartPropertyListener, addPropertyListener, firePartPropertyChanged, firePropertyChange, getAdapter, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, 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.IEditorPart

getEditorInput, getEditorSite

Methods inherited from interface org.eclipse.ui.IWorkbenchPart

addPropertyListener, getSite, getTitle, getTitleToolTip, removePropertyListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Methods inherited from interface org.eclipse.ui.ISaveablePart

isSaveOnCloseNeeded

Field Detail

pageInput

protected java.lang.Object pageInput

inputChangeListener

protected org.eclipse.ui.IPropertyListener inputChangeListener

pageChangedListener

protected org.eclipse.jface.dialogs.IPageChangedListener pageChangedListener

operationHistoryListener

protected org.eclipse.core.commands.operations.IOperationHistoryListener operationHistoryListener

validationProblemMarkersChangeListener

protected IValidationProblemMarkersChangeListener validationProblemMarkersChangeListener

Constructor Detail

AbstractFormPage

public AbstractFormPage(org.eclipse.ui.forms.editor.FormEditor editor,
                java.lang.String title)

AbstractFormPage

public AbstractFormPage(org.eclipse.ui.forms.editor.FormEditor editor,
                java.lang.String id,
                java.lang.String title)

Method Detail

getTransactionalFormEditor

public BasicTransactionalFormEditor getTransactionalFormEditor()

Returns:

The parent transactional form editor of this form page.

getItemDelegator

public org.eclipse.emf.edit.provider.AdapterFactoryItemDelegator getItemDelegator()

getContentProvider

public org.eclipse.jface.viewers.IContentProvider getContentProvider()

createContentProvider

protected org.eclipse.jface.viewers.IContentProvider createContentProvider()

getLabelProvider

public org.eclipse.jface.viewers.IBaseLabelProvider getLabelProvider()

createLabelProvider

protected org.eclipse.jface.viewers.IBaseLabelProvider createLabelProvider()

getSections

public java.util.List<IFormSection> getSections()

Returns the list of sections added to this page by calling addSection(IFormSection)

Returns:

getFormSections

@Deprecated
public java.util.List<IFormSection> getFormSections()

Deprecated. Use getSections() instead.

addSection

protected void addSection(IFormSection section)

setActiveSection

public void setActiveSection(IFormSection section)

Sets the active section on this page.

Parameters:

section -

getActiveSection

public IFormSection getActiveSection()

Returns:

the active section in this page (e.g. the section which have the focus).

getPageInputFromEditor

protected java.lang.Object getPageInputFromEditor()

setPageInput

protected void setPageInput(java.lang.Object pageInput)

canCreateFormContent

protected boolean canCreateFormContent()

createFormContent

protected final void createFormContent(org.eclipse.ui.forms.IManagedForm managedForm)

Overrides:

createFormContent in class org.eclipse.ui.forms.editor.FormPage

doCreateFormContent

protected abstract void doCreateFormContent(org.eclipse.ui.forms.IManagedForm managedForm)

dispose

public void dispose()

Specified by:

dispose in interface org.eclipse.ui.IWorkbenchPart

Overrides:

dispose in class org.eclipse.ui.forms.editor.FormPage

refreshPage

protected final void refreshPage()

doRefreshPage

protected void doRefreshPage()

refreshMessages

protected final void refreshMessages()

doRefreshMessages

protected void doRefreshMessages(org.eclipse.ui.forms.IMessageManager messageManager,
                     java.util.Map<org.eclipse.emf.ecore.EStructuralFeature,java.util.Set<IFormMessage>> messages)

isEmpty

public boolean isEmpty()