IBM Rational Performance Tester SDK

com.ibm.rational.common.test.editor.framework
Class LoadTestEditorForm

java.lang.Object
  extended by org.eclipse.hyades.test.ui.internal.editor.form.base.AbstractForm
      extended by org.eclipse.hyades.test.ui.internal.editor.form.base.AbstractSectionForm
          extended by org.eclipse.hyades.test.ui.internal.editor.form.base.SectionForm
              extended by org.eclipse.hyades.test.ui.internal.editor.form.base.ScrollableSectionForm
                  extended by org.eclipse.hyades.test.ui.editor.form.util.EditorForm
                      extended by com.ibm.rational.common.test.editor.framework.kernel.AbstractLoadTestEditorForm
                          extended by com.ibm.rational.common.test.editor.framework.LoadTestEditorForm
All Implemented Interfaces:
EventListener, org.eclipse.hyades.test.ui.internal.editor.form.base.IForm, org.eclipse.hyades.ui.util.IDisposable, IPropertyChangeListener, PaintListener, org.eclipse.swt.internal.SWTEventListener, ISetSelectionTarget

public class LoadTestEditorForm
extends com.ibm.rational.common.test.editor.framework.kernel.AbstractLoadTestEditorForm

LoadTestEditorForm

This class is used to hold EditorSections in Test Editor.


Nested Class Summary
 
Nested classes/interfaces inherited from class org.eclipse.hyades.test.ui.editor.form.util.EditorForm
org.eclipse.hyades.test.ui.editor.form.util.EditorForm.ArgByReference
 
Field Summary
protected  boolean m_bCreateCommonPropertiesSection
           
protected  LoadTestDetailsSection m_detailsSection
           
protected  TestEditor m_hostTestEditor
           
protected  LoadTestTreeSection m_treeSection
           
 
Fields inherited from class com.ibm.rational.common.test.editor.framework.kernel.AbstractLoadTestEditorForm
LEFT, m_contentProvider, m_labelProvider, m_layoutProvider, m_LeftSections, m_RightSections, m_sashUpdater, RIGHT
 
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
LoadTestEditorForm(TestEditor testEditor, com.ibm.rational.common.test.editor.framework.kernel.util.LoadTestWidgetFactory widgetFactory)
          Constiructor
LoadTestEditorForm(TestEditor testEditor, com.ibm.rational.common.test.editor.framework.kernel.util.LoadTestWidgetFactory widgetFactory, boolean bCreateCommonPropertiesSection)
          Deprecated. Starting with 7.0.1, the support for CommonEditorSection has been removed.
 
Method Summary
protected  void createDefaultProviders()
          Creates default providers used to manage model elements in the editor.
protected  void createEditorFormContents(Composite parent)
          Creates form's contents (sections)
 void dispose()
           
 com.ibm.rational.common.test.editor.framework.kernel.InteractiveLayoutProvider getActiveLayoutProvider()
          Returns current layout provider.
 com.ibm.rational.common.test.editor.framework.kernel.interfaces.IContentProvider getContentProvider(boolean copy)
          Returns default content provider.
 LoadTestDetailsSection getDetailsSection()
          Returns DetailsSection
 com.ibm.rational.common.test.editor.framework.kernel.DetailsEditorSection getDetailsSection(int n)
          Deprecated. Starting from 7.0.1, there is no CommonSection. Calling this method with anything but 0, will return null
protected  com.ibm.rational.common.test.editor.framework.kernel.AbstractEditorSection[] getEditorSections(String side, Composite parentColumn)
          This method is used internqally and should not be called by clients.
 TestEditor getHostTestEditor()
          Returns TestEditor
 com.ibm.rational.common.test.editor.framework.kernel.extensions.LT_LabelProvider getLabelProvider(boolean copy)
          Returns deault LabelProvider
 com.ibm.rational.common.test.editor.framework.kernel.MainEditorSection getMainSection()
          Returns Main/Tree editor section
 LoadTestTreeSection getTreeSection()
          Returns Main/Tree editor section
 void load()
          Called when test resource is loaded from disc.
 void markDirty()
          Marks host test editor as dirty.
 void registerSection(com.ibm.rational.common.test.editor.framework.kernel.AbstractEditorSection section)
          This method must be called once for every newly created section except MainSection.
 void selectReveal(ISelection selection)
          Displays selection in the tree.
 void setActiveLayoutProvider(com.ibm.rational.common.test.editor.framework.kernel.InteractiveLayoutProvider activeLayoutProvider)
          Deprecated.  
 void setEditorWindowTitle()
          Updates editor's window title with information obtained frmom loaded test resource.
 Control setFocusTo(String fieldName, int cursorPos, int selectionLen)
          Sets focus and selection to the named control.
 void setHostTestEditor(TestEditor i_editor)
          Sets Test Editor.
 
Methods inherited from class com.ibm.rational.common.test.editor.framework.kernel.AbstractLoadTestEditorForm
clearDirty, createLeftColumnControls, createRightColumnControls, getContentProvider, getLabelProvider, getLayoutProvider, setContentProvider, setLabelProvider, setLayoutProvider, setWeights
 
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, 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
 

Field Detail

m_treeSection

protected LoadTestTreeSection m_treeSection

m_detailsSection

protected LoadTestDetailsSection m_detailsSection

m_hostTestEditor

protected TestEditor m_hostTestEditor

m_bCreateCommonPropertiesSection

protected boolean m_bCreateCommonPropertiesSection
Constructor Detail

LoadTestEditorForm

public LoadTestEditorForm(TestEditor testEditor,
                          com.ibm.rational.common.test.editor.framework.kernel.util.LoadTestWidgetFactory widgetFactory)
Constiructor

Parameters:
testEditor -
widgetFactory -

LoadTestEditorForm

public LoadTestEditorForm(TestEditor testEditor,
                          com.ibm.rational.common.test.editor.framework.kernel.util.LoadTestWidgetFactory widgetFactory,
                          boolean bCreateCommonPropertiesSection)
Deprecated. Starting with 7.0.1, the support for CommonEditorSection has been removed.

Parameters:
testEditor -
widgetFactory -
Method Detail

load

public void load()
Called when test resource is loaded from disc.

Specified by:
load in class com.ibm.rational.common.test.editor.framework.kernel.AbstractLoadTestEditorForm
See Also:
EditorForm.load()

setEditorWindowTitle

public void setEditorWindowTitle()
Updates editor's window title with information obtained frmom loaded test resource.


createEditorFormContents

protected void createEditorFormContents(Composite parent)
Creates form's contents (sections)

Overrides:
createEditorFormContents in class com.ibm.rational.common.test.editor.framework.kernel.AbstractLoadTestEditorForm
See Also:
org.eclipse.hyades.test.ui.internal.editor.form.util.WidgetFactory#createEditorFormContents(org.eclipse.swt.widgets.Composite)

createDefaultProviders

protected void createDefaultProviders()
Creates default providers used to manage model elements in the editor.


getDetailsSection

public LoadTestDetailsSection getDetailsSection()
Returns DetailsSection

Returns:
LoadTestDetailsSection
See Also:
LoadTestDetailsSection

getTreeSection

public LoadTestTreeSection getTreeSection()
Returns Main/Tree editor section

Returns:
LoadTestTreeSection
See Also:
LoadTestTreeSection

getMainSection

public com.ibm.rational.common.test.editor.framework.kernel.MainEditorSection getMainSection()
Returns Main/Tree editor section

Specified by:
getMainSection in class com.ibm.rational.common.test.editor.framework.kernel.AbstractLoadTestEditorForm
Returns:
MainEditorSection
See Also:
MainEditorSection

getDetailsSection

public com.ibm.rational.common.test.editor.framework.kernel.DetailsEditorSection getDetailsSection(int n)
Deprecated. Starting from 7.0.1, there is no CommonSection. Calling this method with anything but 0, will return null

Returns details section #n

Specified by:
getDetailsSection in class com.ibm.rational.common.test.editor.framework.kernel.AbstractLoadTestEditorForm

getEditorSections

protected com.ibm.rational.common.test.editor.framework.kernel.AbstractEditorSection[] getEditorSections(String side,
                                                                                                         Composite parentColumn)
This method is used internqally and should not be called by clients.

Specified by:
getEditorSections in class com.ibm.rational.common.test.editor.framework.kernel.AbstractLoadTestEditorForm
See Also:
com.ibm.rational.common.editor.framework.kernel.AbstractLoadTestEditorForm#getEditorSections(java.lang.String, org.eclipse.swt.widgets.Composite)

registerSection

public void registerSection(com.ibm.rational.common.test.editor.framework.kernel.AbstractEditorSection section)
This method must be called once for every newly created section except MainSection. This msthod is used internally and should not be called by clients, unless you are writting new test editor for new test type.

See Also:
IForm.registerSection(org.eclipse.hyades.test.ui.internal.editor.form.base.FormSection)

getHostTestEditor

public TestEditor getHostTestEditor()
Returns TestEditor

Returns:
TestEditor
See Also:
TestEditor

setHostTestEditor

public void setHostTestEditor(TestEditor i_editor)
Sets Test Editor. This method is called internally by editor when test resource is loaded from disc. This method should not be called by clients.

Parameters:
i_editor - TestEditor

setFocusTo

public Control setFocusTo(String fieldName,
                          int cursorPos,
                          int selectionLen)
Sets focus and selection to the named control. Calls getLayoutProvider and delegates the operation to it. LT_DefaultLayoutProvider finds ExtLayoutProvider for the currently selected model element, and delegates operation to it.

This method is subject to change in the future version of the product.

Parameters:
fieldName - field to setFocus to
cursorPos - caret offset inside the field
selectionLen - length of selection

getContentProvider

public com.ibm.rational.common.test.editor.framework.kernel.interfaces.IContentProvider getContentProvider(boolean copy)
Returns default content provider.

Overrides:
getContentProvider in class com.ibm.rational.common.test.editor.framework.kernel.AbstractLoadTestEditorForm
Returns:
IContentProvider Content provider
See Also:
AbstractLoadTestEditorForm.getContentProvider(boolean)

getLabelProvider

public com.ibm.rational.common.test.editor.framework.kernel.extensions.LT_LabelProvider getLabelProvider(boolean copy)
Returns deault LabelProvider

Overrides:
getLabelProvider in class com.ibm.rational.common.test.editor.framework.kernel.AbstractLoadTestEditorForm
Returns:
LabelProvider
See Also:
AbstractLoadTestEditorForm.getLabelProvider(boolean)

markDirty

public void markDirty()
Marks host test editor as dirty. Dirty editors can be saved.


selectReveal

public void selectReveal(ISelection selection)
Displays selection in the tree.

Specified by:
selectReveal in interface ISetSelectionTarget
Overrides:
selectReveal in class org.eclipse.hyades.test.ui.editor.form.util.EditorForm

getActiveLayoutProvider

public com.ibm.rational.common.test.editor.framework.kernel.InteractiveLayoutProvider getActiveLayoutProvider()
Returns current layout provider.

Returns:
InteractiveLayoutprovider or null
See Also:
ExtLayoutProvider

setActiveLayoutProvider

public void setActiveLayoutProvider(com.ibm.rational.common.test.editor.framework.kernel.InteractiveLayoutProvider activeLayoutProvider)
Deprecated. 

Sets current layout provider. This method is used internally by Test editor and should not be called by clients.

Parameters:
activeLayoutProvider - The activeLayoutProvider to set.

dispose

public void dispose()
Specified by:
dispose in interface org.eclipse.hyades.test.ui.internal.editor.form.base.IForm
Specified by:
dispose in interface org.eclipse.hyades.ui.util.IDisposable
Overrides:
dispose in class com.ibm.rational.common.test.editor.framework.kernel.AbstractLoadTestEditorForm

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.