org.eclipse.hyades.test.ui.internal.editor.form
Class ConfigurableObjectOverviewForm

java.lang.Object
  org.eclipse.hyades.test.ui.internal.editor.form.base.AbstractForm
      org.eclipse.hyades.test.ui.internal.editor.form.base.AbstractSectionForm
          org.eclipse.hyades.test.ui.internal.editor.form.base.SectionForm
              org.eclipse.hyades.test.ui.internal.editor.form.base.ScrollableSectionForm
                  org.eclipse.hyades.test.ui.editor.form.util.EditorForm
                      org.eclipse.hyades.test.ui.internal.editor.form.ConfigurableObjectOverviewForm

All Implemented Interfaces:

java.util.EventListener, org.eclipse.hyades.ui.util.IDisposable, IForm, org.eclipse.jface.util.IPropertyChangeListener, org.eclipse.ui.part.ISetSelectionTarget, org.eclipse.swt.events.PaintListener, org.eclipse.swt.internal.SWTEventListener

Direct Known Subclasses:

ArtifactForm, DeploymentForm, LocationForm, LocationsForm

public class ConfigurableObjectOverviewForm

extends org.eclipse.hyades.test.ui.editor.form.util.EditorForm

This class provides a base implementation for CFGConfigurableObject editor overview page.

Since:

1.3

Nested Class Summary

Nested classes inherited from class org.eclipse.hyades.test.ui.editor.form.util.EditorForm

org.eclipse.hyades.test.ui.editor.form.util.EditorForm.ArgByReference

Field Summary

Fields inherited from class org.eclipse.hyades.test.ui.internal.editor.form.base.SectionForm

heightHint, widthHint

Fields inherited from class org.eclipse.hyades.test.ui.internal.editor.form.base.AbstractSectionForm

H_SCROLL_INCREMENT, sections, V_SCROLL_INCREMENT

Fields inherited from class org.eclipse.hyades.test.ui.internal.editor.form.base.AbstractForm

factory, headingBackground, headingForeground, headingImage, headingText, headingVisible, titleFont

Constructor Summary

ConfigurableObjectOverviewForm(ConfigurableObjectEditorExtension editorExtension, org.eclipse.hyades.test.ui.editor.form.util.WidgetFactory widgetFactory)
Constructor for ConfigurableObjectOverviewForm

Method Summary

boolean	activated()
void	addSection(IPropertyGroupForm propGroupExtensionForm, int pageIndex) Adds a new section on this overview page to link to the specified property group page.
protected void	createEditorFormContents(org.eclipse.swt.widgets.Composite parent)
protected void	createGeneralInfoSection(org.eclipse.swt.widgets.Composite parent) Method used to create the general information section on this overview page.
protected RegisteredExtensionsSection	createPropertyGroupExtensionsSection(org.eclipse.swt.widgets.Composite parent) Method used to create a section to list property group extensions "org.eclipse.hyades.test.ui.configurableObjectExtension" on this overview page.
void	dispose()
protected org.eclipse.emf.ecore.EObject	getDataObject() Returns the data object that is manipulated by this editor.
protected FormSection	getGeneralInfoSection()
protected org.eclipse.swt.widgets.Composite	getLeftColumnContainer() Returns the left column composite which is one of the two columns made up this overview page.
protected RegisteredExtensionsSection	getPropertyGroupsSection() Returns the section for property group extensions or null if it is not created.
protected org.eclipse.swt.widgets.Composite	getRightColumnContainer() Returns the right column composite which is one of the two columns made up this overview page.
void	load()
protected void	setGeneralInfoSection(FormSection section)
protected void	setGeneralInfoSectionHelp(org.eclipse.swt.widgets.Control control) Sub classes should override this method to add their own help.
void	updateTitle()

Methods inherited from class org.eclipse.hyades.test.ui.editor.form.util.EditorForm

createColumn, createControl, createFormClient, getBaseEditorExtension, getCurrentSelection, getStatusLineManager, getWidgetFactory, init, selectReveal

Methods inherited from class org.eclipse.hyades.test.ui.internal.editor.form.base.ScrollableSectionForm

createControl, createParent, isScrollable, isVerticalFit, setScrollable, setVerticalFit, update, updateScrollBars, updateScrolledComposite

Methods inherited from class org.eclipse.hyades.test.ui.internal.editor.form.base.SectionForm

getControl, getTitleHeight, paintControl, propertyChange, setHeadingText, setHeadingVisible

Methods inherited from class org.eclipse.hyades.test.ui.internal.editor.form.base.AbstractSectionForm

canPaste, commitChanges, doGlobalAction, ensureVisible, ensureVisible, getControlLocation, getFocusControl, initialize, registerSection, scrollHorizontal, scrollPage, scrollVertical, setFocus, unregisterSection, updatePageIncrement

Methods inherited from class org.eclipse.hyades.test.ui.internal.editor.form.base.AbstractForm

canPerformDirectly, expandTo, getFactory, getHeadingBackground, getHeadingForeground, getHeadingImage, getHeadingText, isHeadingVisible, setHeadingBackground, setHeadingForeground, setHeadingImage, updateHyperlinkColors

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurableObjectOverviewForm

public ConfigurableObjectOverviewForm(ConfigurableObjectEditorExtension editorExtension,
                                      org.eclipse.hyades.test.ui.editor.form.util.WidgetFactory widgetFactory)

Constructor for ConfigurableObjectOverviewForm

Parameters:

editorExtension -

widgetFactory -

Method Detail

dispose

public void dispose()

See Also:

org.eclipse.update.ui.forms.internal.IForm#dispose()

getLeftColumnContainer

protected org.eclipse.swt.widgets.Composite getLeftColumnContainer()

Returns the left column composite which is one of the two columns made up this overview page.

Returns:

getRightColumnContainer

protected org.eclipse.swt.widgets.Composite getRightColumnContainer()

Returns the right column composite which is one of the two columns made up this overview page.

Returns:

getGeneralInfoSection

protected FormSection getGeneralInfoSection()

setGeneralInfoSection

protected void setGeneralInfoSection(FormSection section)

getDataObject

protected org.eclipse.emf.ecore.EObject getDataObject()

Returns the data object that is manipulated by this editor.

Returns:

EObject

createEditorFormContents

protected void createEditorFormContents(org.eclipse.swt.widgets.Composite parent)

createGeneralInfoSection

protected void createGeneralInfoSection(org.eclipse.swt.widgets.Composite parent)

Method used to create the general information section on this overview page. Sub classes may use or override this method to custimize it.

Parameters:

parent -

setGeneralInfoSectionHelp

protected void setGeneralInfoSectionHelp(org.eclipse.swt.widgets.Control control)

Sub classes should override this method to add their own help.

Parameters:

control -

createPropertyGroupExtensionsSection

protected RegisteredExtensionsSection createPropertyGroupExtensionsSection(org.eclipse.swt.widgets.Composite parent)

Method used to create a section to list property group extensions "org.eclipse.hyades.test.ui.configurableObjectExtension" on this overview page. This section is not created by default, so sub classes should call this method to add this section at will. It can also be overridden for customization.

Parameters:

parent -

getPropertyGroupsSection

protected RegisteredExtensionsSection getPropertyGroupsSection()

Returns the section for property group extensions or null if it is not created.

Returns:

addSection

public void addSection(IPropertyGroupForm propGroupExtensionForm,
                       int pageIndex)

Adds a new section on this overview page to link to the specified property group page. A new section will be added for each property group page created. Sub classes can override this method to customize this section.

Parameters:

propGroupExtensionForm -

pageIndex -

load

public void load()

updateTitle

public void updateTitle()

See Also:

org.eclipse.hyades.test.ui.internal.editor.form.common.EditorForm#updateTitle()

activated

public boolean activated()

See Also:

org.eclipse.hyades.test.ui.internal.editor.form.common.EditorForm#activated()