org.eclipse.cosmos.rm.smlif.internal.editor
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.cosmos.rm.smlif.internal.editor.AbstractFormPage

All Implemented Interfaces:

java.util.EventListener, org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.IExecutableExtension, org.eclipse.swt.events.ModifyListener, org.eclipse.swt.internal.SWTEventListener, 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:

DocumentsPage, OverviewPage

public abstract class AbstractFormPage
extends org.eclipse.ui.forms.editor.FormPage
implements org.eclipse.swt.events.ModifyListener

An abstract form page that all other form pages are expected to extend.

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

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

Method Summary

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)
protected abstract void	createLeftColumn(org.eclipse.swt.widgets.Composite parent) Create the left column content of the page
protected abstract void	createRightColumn(org.eclipse.swt.widgets.Composite parent) Create the right column content of the page
protected org.eclipse.ui.forms.widgets.Section	createSection(org.eclipse.swt.widgets.Composite parent) Create and return a section
protected org.eclipse.swt.widgets.Text	createTextField(org.eclipse.swt.widgets.Composite parent, java.lang.String label, boolean multiLine, java.lang.String initialValue, org.eclipse.swt.events.ModifyListener modifyListener) Create a label and a text field.
protected org.eclipse.swt.widgets.Text	createTextField(org.eclipse.swt.widgets.Composite parent, java.lang.String label, java.lang.String initialValue, org.eclipse.swt.events.ModifyListener modifyListener) Equivalent to createTextField(parent, label, false, initialValue, modifyListener)
void	doSave(org.eclipse.core.runtime.IProgressMonitor monitor)
protected boolean	isEnabled() Returns true if this form is suppose to be enabled; false otherwise
protected void	makeSectionReady(org.eclipse.ui.forms.widgets.Section section, org.eclipse.swt.widgets.Composite client, java.lang.String title) Set the appropriate properties of the section
void	modifyText(org.eclipse.swt.events.ModifyEvent e)
protected void	setEnabled(boolean enabled) Used to set the enable status of this page
protected void	setWeight(org.eclipse.swt.custom.SashForm sashForm)
protected abstract void	updateContent() This method is invoked when the content of the SML-IF document has changed outside of the SML-IF document.

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

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

AbstractFormPage

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

Method Detail

createFormContent

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

Overrides:

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

See Also:

FormPage.createFormContent(org.eclipse.ui.forms.IManagedForm)

setWeight

protected void setWeight(org.eclipse.swt.custom.SashForm sashForm)

createLeftColumn

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

Create the left column content of the page

Parameters:

parent - The parent composite

createRightColumn

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

Create the right column content of the page

Parameters:

parent - The parent composite

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:

toolkit -

parent - The parent composite

Returns:

Composite The column composite

createSection

protected org.eclipse.ui.forms.widgets.Section createSection(org.eclipse.swt.widgets.Composite parent)

Create and return a section

Returns:

A section

createTextField

protected org.eclipse.swt.widgets.Text createTextField(org.eclipse.swt.widgets.Composite parent,
                                                       java.lang.String label,
                                                       boolean multiLine,
                                                       java.lang.String initialValue,
                                                       org.eclipse.swt.events.ModifyListener modifyListener)

Create a label and a text field. The controls will be layedout horizonally:

Parameters:

parent - The parent composite

label - The label text

multiLine - Whether the text box should be multi-line

initialValue - The initial value of the text box

modifyListener - The modify listener that will be registered with the text box

createTextField

protected org.eclipse.swt.widgets.Text createTextField(org.eclipse.swt.widgets.Composite parent,
                                                       java.lang.String label,
                                                       java.lang.String initialValue,
                                                       org.eclipse.swt.events.ModifyListener modifyListener)

Equivalent to createTextField(parent, label, false, initialValue, modifyListener)

modifyText

public void modifyText(org.eclipse.swt.events.ModifyEvent e)

Specified by:

modifyText in interface org.eclipse.swt.events.ModifyListener

See Also:

ModifyListener.modifyText(org.eclipse.swt.events.ModifyEvent)

makeSectionReady

protected void makeSectionReady(org.eclipse.ui.forms.widgets.Section section,
                                org.eclipse.swt.widgets.Composite client,
                                java.lang.String title)

Set the appropriate properties of the section

Parameters:

section - The section

client - The section client

title - The title of the section

setEnabled

protected void setEnabled(boolean enabled)

Used to set the enable status of this page

Parameters:

enabled - The enable status

isEnabled

protected boolean isEnabled()

Returns true if this form is suppose to be enabled; false otherwise

Returns:

true if this form is suppose to be enabled; false otherwise

doSave

public void doSave(org.eclipse.core.runtime.IProgressMonitor monitor)

Specified by:

doSave in interface org.eclipse.ui.ISaveablePart

Overrides:

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

See Also:

FormPage.doSave(org.eclipse.core.runtime.IProgressMonitor)

updateContent

protected abstract void updateContent()

This method is invoked when the content of the SML-IF document has changed outside of the SML-IF document.