TPTP 4.4.0 Testing Tools Project
Internal API Specification

org.eclipse.hyades.test.ui.internal.editor.form
Interface IPropertyGroupForm

All Superinterfaces:
org.eclipse.ui.part.ISetSelectionTarget
All Known Implementing Classes:
PropertyGroupForm, WorkbenchPropertyGroupForm

public interface IPropertyGroupForm
extends org.eclipse.ui.part.ISetSelectionTarget

Interface of configuration editor forms that extension instances of Hyades extension point org.eclipse.hyades.test.ui.configurationEditorForm should implement.

Since:
1.3

Method Summary
 org.eclipse.swt.widgets.Control createControl()
          Creates the control of this form.
 java.lang.String getDescription()
           
 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()
          Returns the specific selected object in this form.
 void init(org.eclipse.hyades.models.common.configuration.CFGPropertyGroup group, org.eclipse.hyades.test.ui.editor.extension.BaseEditorExtension baseEditorExtension, org.eclipse.hyades.test.ui.editor.form.util.WidgetFactory widgetFactory)
          Initializes the property group form.
 void load()
          Subclasses should load the persited values to 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.
 

Method Detail

setExtension

public void setExtension(org.eclipse.core.runtime.IConfigurationElement extension)
Sets the IConfigurationElement object the instance of this class is created for.

Parameters:
extension -

getName

public java.lang.String getName()

getDescription

public java.lang.String getDescription()

getPropertyGroup

public org.eclipse.hyades.models.common.configuration.CFGPropertyGroup getPropertyGroup()
Returns the CFGPropertyGroup object this form is editing.


init

public void init(org.eclipse.hyades.models.common.configuration.CFGPropertyGroup group,
                 org.eclipse.hyades.test.ui.editor.extension.BaseEditorExtension baseEditorExtension,
                 org.eclipse.hyades.test.ui.editor.form.util.WidgetFactory widgetFactory)
Initializes the property group form.

Since:
4.1

createControl

public org.eclipse.swt.widgets.Control createControl()
Creates the control of this form.

Returns:
Control

load

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


getSelection

public org.eclipse.jface.viewers.IStructuredSelection getSelection()
Returns the specific selected object in this form.

Returns:
IStructuredSelection

selectReveal

public void selectReveal(org.eclipse.jface.viewers.ISelection selection)
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 org.eclipse.ui.part.ISetSelectionTarget
Parameters:
selection - the selction should be revealed.
See Also:
ISetSelectionTarget.selectReveal(org.eclipse.jface.viewers.ISelection)

TPTP 4.4.0 Testing Tools Project
Internal API Specification