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

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.PropertyGroupForm

All Implemented Interfaces:

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

public class PropertyGroupForm

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

implements IPropertyGroupForm

This is the default implementation class of extension point org.eclipse.hyades.test.ui.configurationEditorForm. Extensions may choose to extend this class or simply use directly.

Since:

1.3

Nested Class Summary

class	PropertyGroupForm.PropertyGroupTableLabelProvider This is a ITableLabelProvider class that knows what text to display in the table control of a IPropertyGroupForm with a given CFGComparableProperty object.
protected class	PropertyGroupForm.PropertyGroupTableSection

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

static java.lang.String	CONTROL_TYPE_CUSTOM
static java.lang.String	CONTROL_TYPE_FIELDS
static java.lang.String	CONTROL_TYPE_TABLE
static java.lang.String	CONTROL_TYPE_TREE

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

PropertyGroupForm()

Method Summary

protected org.eclipse.jface.action.IAction[]	createButtonActions() Creates the actions of the buttons that the primary editor section will use.
protected void	createEditorFormContents(org.eclipse.swt.widgets.Composite parent) Creates the contents of this editor form.
protected org.eclipse.hyades.test.ui.editor.form.util.EditorSection	createTableSection(org.eclipse.swt.widgets.Composite parent) Creates a table section with add, remove, move up, move down buttons as the main control of this form.
protected org.eclipse.hyades.test.ui.editor.form.util.EditorSection	createTreeSection(org.eclipse.swt.widgets.Composite parent) Creates a tree section with add, remove, move up, move down buttons as the main control of this form.
void	dispose()
boolean	doGlobalAction(java.lang.String actionId)
java.lang.String	getAppliesTo() Returns which CFGConfigurableObject's property group this form is editing.
java.lang.String	getControlType() Returns the type of the control this form contains.
java.lang.String	getDescription()
protected org.eclipse.emf.ecore.EObject	getEditorObject() Returns the data object that is manipulated by the editor that this form belongs.
java.lang.String	getName()
org.eclipse.hyades.models.common.configuration.CFGPropertyGroup	getPropertyGroup() Returns the CFGPropertyGroup object this form is editing.
org.eclipse.jface.viewers.IStructuredSelection	getSelection() Subclass should override this method to return the specific selected object in the form.
void	init(org.eclipse.hyades.models.common.configuration.CFGPropertyGroup propertyGroup, org.eclipse.hyades.test.ui.editor.extension.BaseEditorExtension editorExtension, org.eclipse.hyades.test.ui.editor.form.util.WidgetFactory widgetFactory) Initializes the property group form.
void	load() Subclasses should load the persited values in the controls in this method.
void	selectReveal(org.eclipse.jface.viewers.ISelection selection) Sets the selection in this form to be revealed when the form is activated.
void	setExtension(org.eclipse.core.runtime.IConfigurationElement extension) Sets the IConfigurationElement object the instance of this class is created for.

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

activated, createColumn, createControl, createFormClient, getBaseEditorExtension, getCurrentSelection, getStatusLineManager, getWidgetFactory, init, updateTitle

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, 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

Methods inherited from interface org.eclipse.hyades.test.ui.internal.editor.form.IPropertyGroupForm

createControl

Field Detail

CONTROL_TYPE_CUSTOM

public static final java.lang.String CONTROL_TYPE_CUSTOM

See Also:

Constant Field Values

CONTROL_TYPE_TABLE

public static final java.lang.String CONTROL_TYPE_TABLE

See Also:

Constant Field Values

CONTROL_TYPE_TREE

public static final java.lang.String CONTROL_TYPE_TREE

See Also:

Constant Field Values

CONTROL_TYPE_FIELDS

public static final java.lang.String CONTROL_TYPE_FIELDS

See Also:

Constant Field Values

Constructor Detail

PropertyGroupForm

public PropertyGroupForm()

Method Detail

init

public void init(org.eclipse.hyades.models.common.configuration.CFGPropertyGroup propertyGroup,
                 org.eclipse.hyades.test.ui.editor.extension.BaseEditorExtension editorExtension,
                 org.eclipse.hyades.test.ui.editor.form.util.WidgetFactory widgetFactory)

Description copied from interface: IPropertyGroupForm

Initializes the property group form.

Specified by:

init in interface IPropertyGroupForm

setExtension

public void setExtension(org.eclipse.core.runtime.IConfigurationElement extension)

Description copied from interface: IPropertyGroupForm

Sets the IConfigurationElement object the instance of this class is created for.

Specified by:

setExtension in interface IPropertyGroupForm

Parameters:

extension -

getName

public java.lang.String getName()

Specified by:

getName in interface IPropertyGroupForm

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface IPropertyGroupForm

getPropertyGroup

public org.eclipse.hyades.models.common.configuration.CFGPropertyGroup getPropertyGroup()

Description copied from interface: IPropertyGroupForm

Returns the CFGPropertyGroup object this form is editing.

Specified by:

getPropertyGroup in interface IPropertyGroupForm

getControlType

public java.lang.String getControlType()

Returns the type of the control this form contains.

Returns:

one of "table", "tree", "fields" or "custom".

getAppliesTo

public java.lang.String getAppliesTo()

Returns which CFGConfigurableObject's property group this form is editing.

Returns:

a CFGConfigurableObject concrete class name.

dispose

public void dispose()

Specified by:

dispose in interface org.eclipse.hyades.ui.util.IDisposable

See Also:

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

getEditorObject

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

Returns the data object that is manipulated by the editor that this form belongs.

Returns:

EObject

createEditorFormContents

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

Creates the contents of this editor form.

Parameters:

parent -

createTreeSection

protected org.eclipse.hyades.test.ui.editor.form.util.EditorSection createTreeSection(org.eclipse.swt.widgets.Composite parent)

Creates a tree section with add, remove, move up, move down buttons as the main control of this form.

Parameters:

parent -

Returns:

a EditorSection

createTableSection

protected org.eclipse.hyades.test.ui.editor.form.util.EditorSection createTableSection(org.eclipse.swt.widgets.Composite parent)

Creates a table section with add, remove, move up, move down buttons as the main control of this form.

Parameters:

parent -

Returns:

a EditorSection

createButtonActions

protected org.eclipse.jface.action.IAction[] createButtonActions()

Creates the actions of the buttons that the primary editor section will use.

Returns:

load

public void load()

Subclasses should load the persited values in the controls in this method. The goal is to provide a common behavior for the editor forms.

Specified by:

load in interface IPropertyGroupForm

getSelection

public org.eclipse.jface.viewers.IStructuredSelection getSelection()

Subclass should override this method to return the specific selected object in the form. This default implementation just returns the data object of the overall editor.

Specified by:

getSelection in interface IPropertyGroupForm

Returns:

IStructuredSelection

selectReveal

public void selectReveal(org.eclipse.jface.viewers.ISelection selection)

Description copied from interface: IPropertyGroupForm

Sets the selection in this form to be revealed when the form is activated. This method is called from the configurable object overview page, when a hyper-link representing one of the properties of this property group is activated to bring this form on top.

Specified by:

selectReveal in interface IPropertyGroupForm

See Also:

ISetSelectionTarget.selectReveal(org.eclipse.jface.viewers.ISelection)

doGlobalAction

public boolean doGlobalAction(java.lang.String actionId)

Specified by:

doGlobalAction in interface IForm

Overrides:

doGlobalAction in class AbstractSectionForm

See Also:

org.eclipse.update.ui.forms.internal.FormSection#doGlobalAction(java.lang.String)