org.eclipse.hyades.test.ui.internal.editor.form.util
Class EditorEclipseForm

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.hyades.test.ui.internal.editor.form.util.EditorEclipseForm

All Implemented Interfaces:

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

Direct Known Subclasses:

BehaviorEclipseForm, OverviewEclipseForm, TestCasesEclipseForm

public abstract class EditorEclipseForm

extends org.eclipse.ui.forms.editor.FormPage

Created in response to the deprecation of EditorForm. This provides an extended number of APIs required by the test suite forms.

Field Summary

Fields inherited from interface org.eclipse.ui.IEditorPart

PROP_DIRTY, PROP_INPUT

Fields inherited from interface org.eclipse.ui.IWorkbenchPart

PROP_TITLE

Constructor Summary

EditorEclipseForm(org.eclipse.hyades.ui.editor.IEditorExtension editor, java.lang.String editorTitle, java.lang.String id, java.lang.String title)
The constructor

Method Summary

boolean	activated() Invoked when the form is activated.
protected void	addDetails(DetailsPageProvider detailProvider) Clients have the option of implementing a details section in their forms.
protected org.eclipse.swt.widgets.Composite	createColumn(org.eclipse.swt.widgets.Composite parent) Creates a composite that corresponds to the a column in the given parent.
protected void	createFormContent(org.eclipse.ui.forms.IManagedForm managedForm) A method that is used to derive a standard template for each of the pages of the test suite editor.
protected abstract void	createLeftColumnControls(org.eclipse.swt.widgets.Composite parent) The left column controls of the page are created by this method
protected abstract void	createRightColumnControls(org.eclipse.swt.widgets.Composite parent) The right column controls of the page are created by this method
protected org.eclipse.hyades.models.common.facades.behavioral.ITestSuite	getCommonTestSuite() Returns the test case suite manipulated by this form.
java.lang.String	getEditorTitle() Returns the editor title.
protected org.eclipse.ui.forms.widgets.ScrolledForm	getForm()
org.eclipse.hyades.ui.editor.IEditorExtension	getFormEditor() Returns the form editor that this form is apart of
protected void	markEditorDirty() Marks the editor dirty.
void	updateTitle() Updates this editor form title.

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

canLeaveThePage, createPartControl, dispose, 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

Constructor Detail

EditorEclipseForm

public EditorEclipseForm(org.eclipse.hyades.ui.editor.IEditorExtension editor,
                         java.lang.String editorTitle,
                         java.lang.String id,
                         java.lang.String title)

The constructor

Parameters:

editorTitle - The title of the editor

editor - The form editor that this form is apart of

id - The id of the form

title - The title of the form

Method Detail

createColumn

protected org.eclipse.swt.widgets.Composite createColumn(org.eclipse.swt.widgets.Composite parent)

Creates a composite that corresponds to the a column in the given parent.

Parameters:

parent - The parent composite

Returns:

Composite The column composite

activated

public boolean activated()

Invoked when the form is activated. Usually over-written by clients.

Returns:

Whether this form is activated

updateTitle

public void updateTitle()

Updates this editor form title. Usually over-written by clients.

getCommonTestSuite

protected org.eclipse.hyades.models.common.facades.behavioral.ITestSuite getCommonTestSuite()

Returns the test case suite manipulated by this form.

Returns:

The model that we modified

createFormContent

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

A method that is used to derive a standard template for each of the pages of the test suite editor. Clients are of course not obligated to follow this template.

createRightColumnControls

protected abstract void createRightColumnControls(org.eclipse.swt.widgets.Composite parent)

The right column controls of the page are created by this method

Parameters:

parent - The parent composite

createLeftColumnControls

protected abstract void createLeftColumnControls(org.eclipse.swt.widgets.Composite parent)

The left column controls of the page are created by this method

Parameters:

parent - The parent composite

getFormEditor

public org.eclipse.hyades.ui.editor.IEditorExtension getFormEditor()

Returns the form editor that this form is apart of

Returns:

The form editor.

addDetails

protected void addDetails(DetailsPageProvider detailProvider)

Clients have the option of implementing a details section in their forms.

getEditorTitle

public java.lang.String getEditorTitle()

Returns the editor title.

Returns:

The editor title

markEditorDirty

protected void markEditorDirty()

Marks the editor dirty.

getForm

protected org.eclipse.ui.forms.widgets.ScrolledForm getForm()