IBM Rational Performance Tester SDK

com.ibm.rational.common.test.editor.framework.extensions
Class DefaultTestLayoutProvider

java.lang.Object
  extended by com.ibm.rational.common.test.editor.framework.kernel.AbstractLayoutProvider
      extended by com.ibm.rational.common.test.editor.framework.kernel.InteractiveLayoutProvider
          extended by com.ibm.rational.common.test.editor.framework.extensions.ExtLayoutProvider
              extended by com.ibm.rational.common.test.editor.framework.extensions.DefaultTestLayoutProvider
All Implemented Interfaces:
IExtensiblePrivider, com.ibm.rational.common.test.editor.framework.kernel.interfaces.ILayoutProvider, com.ibm.rational.common.test.editor.framework.kernel.interfaces.ILayoutProvider2, com.ibm.rational.common.test.editor.framework.kernel.interfaces.ILayoutProvider3, com.ibm.rational.common.test.editor.framework.kernel.interfaces.IListBoxSelectionListener, com.ibm.rational.common.test.editor.framework.kernel.interfaces.IResetable, EventListener, IExecutableExtension, org.eclipse.hyades.test.ui.editor.form.base.IHyperlinkListener, KeyListener, ModifyListener, MouseListener, SelectionListener, org.eclipse.swt.internal.SWTEventListener

public abstract class DefaultTestLayoutProvider
extends ExtLayoutProvider

Default layout provider to be used for root test object. This class loads and displays options.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.ibm.rational.common.test.editor.framework.extensions.ExtLayoutProvider
ExtLayoutProvider.ExpandBlockAction
 
Field Summary
static String _OPTIONS_ID
           
 
Fields inherited from class com.ibm.rational.common.test.editor.framework.kernel.InteractiveLayoutProvider
HL_COMMAND, HL_DEST_OBJECT, HL_DESTINATION
 
Fields inherited from class com.ibm.rational.common.test.editor.framework.kernel.AbstractLayoutProvider
m_details
 
Fields inherited from interface com.ibm.rational.common.test.editor.framework.kernel.interfaces.ILayoutProvider
CTRL_NAME
 
Constructor Summary
DefaultTestLayoutProvider()
           
 
Method Summary
 Composite drawBottomPart(Composite parent, boolean sNew)
           
protected  void drawOptions(CTabFolder folder, boolean sNew)
           
 Composite drawUpperPart(SashForm parent, boolean sNew)
           
 void flushCachedData()
           
protected  CTabFolder getFolder()
           
protected  int getTabLinksThreshold()
          Returns minimum number of optons tabs for which no links need to be drawn.
protected  boolean isValidFeature(String attribute)
          Verifies that the feature is enabled for the given test.
protected  boolean isValidType(String type)
          Verifies that the given test type (specified via testOptions extension point) is applicable to this Test.
 boolean layoutControls(CBActionElement selectedElement)
          Implementing classes should override and provide UI for editing.
 void linkActivated(Control linkLabel)
           
 boolean linkActivated2(Object data)
           
 boolean navigateTo(com.ibm.rational.common.test.editor.framework.kernel.interfaces.ITargetDescriptor targetDescriptor)
           
 boolean refreshControls(CBActionElement selectedElement)
          Implementing classes should override and provide UI for editing.
protected  void setFolder(CTabFolder folder)
           
 
Methods inherited from class com.ibm.rational.common.test.editor.framework.extensions.ExtLayoutProvider
beforeHide, createAdvancedControls, createAlwaysLogUi, createExceptionHandling, createExceptionsUi, createRequirements, createRequirementsUi, createSashForm, createSashFormBlock, enableComposite, fixSashColors, getAdvancedTabbed, getConfigElem, getDetails, getMultiSelectLayoutProvider, getReqUi, getTextField, isInitialized, isShowAdvancedTab, isShowExceptionHandlingUi, keyReleased, modifyText, mouseDoubleClick, objectChanged, onTabSelected, refreshDescription, setDetails, setFocusTo, setInitializationData, setInitialized, setReqUi, setSelection, setTabVisible, widgetSelected
 
Methods inherited from class com.ibm.rational.common.test.editor.framework.kernel.InteractiveLayoutProvider
addField, beforeShow, displayBooleanValue, displayNumericValue, displayOptionsAsCombo, displayOptionsAsComboWithToggle, displayOptionsAsRadioButtons, displayTextValue, displayTimePeriodValue, displayTimePeriodValue, getControl, getCtrlName, getCurrentField, getField, hidden, isForceUpdate, keyPressed, linkEntered, linkExited, mouseDown, mouseUp, refreshTree, removeField, setButtonLayoutData, setControlName, setCtrlText, setCurrentField, setForceUpdate, setGridData_Fill, setGridData_Hor, setHyperLink, setLayout, setStyledTextValue, setText, updateEnabledState, updateFieldsFromModel, updateTreeView, widgetDefaultSelected
 
Methods inherited from class com.ibm.rational.common.test.editor.framework.kernel.AbstractLayoutProvider
dispose, getFactory, getSelection, getTestEditor, isNewSelection, layoutControls, refreshControls, setMultiSelectLayoutProvider, setNewSelection, setTestEditor, supportsMultiEdit
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.rational.common.test.editor.framework.extensions.IExtensiblePrivider
getTestEditor, setTestEditor
 

Field Detail

_OPTIONS_ID

public static String _OPTIONS_ID
Constructor Detail

DefaultTestLayoutProvider

public DefaultTestLayoutProvider()
Method Detail

isValidFeature

protected boolean isValidFeature(String attribute)
Verifies that the feature is enabled for the given test. By the time this method is called, getTestEditor() will return a valid TestEditor object.

This implementation always returns true.

Editors that support multiple features need to override this method and supply proper checks.

Parameters:
attribute - String feature_id specified via extension.
Returns:
boolean true

flushCachedData

public void flushCachedData()
Specified by:
flushCachedData in interface com.ibm.rational.common.test.editor.framework.kernel.interfaces.IResetable
Overrides:
flushCachedData in class ExtLayoutProvider
See Also:
IResetable.flushCachedData()

isValidType

protected boolean isValidType(String type)
Verifies that the given test type (specified via testOptions extension point) is applicable to this Test. By the time this method is called, getTestEditor() will return a valid TestEditor object.

This implementation performs the following check:

return ( type != null ) && getTestEditor().getTest().getType().equals( type );

Client typically do not need to overridethis method.

Parameters:
type - String type specified via extension.
Returns:
boolean true

drawOptions

protected void drawOptions(CTabFolder folder,
                           boolean sNew)

drawUpperPart

public Composite drawUpperPart(SashForm parent,
                               boolean sNew)
Parameters:
parent -
Returns:
true if there was anything to display, false otherwise.

drawBottomPart

public Composite drawBottomPart(Composite parent,
                                boolean sNew)
Parameters:
parent -
Returns:
true if there was anything to display, false otherwise.

layoutControls

public boolean layoutControls(CBActionElement selectedElement)
Description copied from class: ExtLayoutProvider
Implementing classes should override and provide UI for editing. However, first thing, must call super.layoutControls(selection)

Specified by:
layoutControls in interface com.ibm.rational.common.test.editor.framework.kernel.interfaces.ILayoutProvider
Overrides:
layoutControls in class ExtLayoutProvider
Parameters:
selectedElement - CBActionElement
Returns:
boolean true. .
See Also:
com.ibm.rational.common.editor.framework.kernel.interfaces.ILayoutProvider#layoutControls(org.eclipse.jface.viewers.StructuredSelection)

getTabLinksThreshold

protected int getTabLinksThreshold()
Returns minimum number of optons tabs for which no links need to be drawn. If the number of actual tabs are greater than the return value, hyperlinks will be drawn below the tab folder. Each hyperlink will activate corresponding option tab. If total number of tabs is greater than ten, only first ten will will be represented by hyperlinks, and the "More..." link will be added at the end. The "More" link will display popup menu with the entire list of tabs.

Labels for links and popup menu items are the same as labels of the tabs.

Returns:
int.

linkActivated

public void linkActivated(Control linkLabel)
Specified by:
linkActivated in interface org.eclipse.hyades.test.ui.editor.form.base.IHyperlinkListener
Overrides:
linkActivated in class com.ibm.rational.common.test.editor.framework.kernel.InteractiveLayoutProvider

linkActivated2

public boolean linkActivated2(Object data)

refreshControls

public boolean refreshControls(CBActionElement selectedElement)
Description copied from class: ExtLayoutProvider
Implementing classes should override and provide UI for editing. However, first thing, must call super.refreshControls(selection)

Specified by:
refreshControls in interface com.ibm.rational.common.test.editor.framework.kernel.interfaces.ILayoutProvider
Overrides:
refreshControls in class ExtLayoutProvider
Returns:
boolean true.
See Also:
com.ibm.rational.common.editor.framework.kernel.interfaces.ILayoutProvider#refreshControls(org.eclipse.jface.viewers.StructuredSelection)

getFolder

protected CTabFolder getFolder()

setFolder

protected void setFolder(CTabFolder folder)

navigateTo

public boolean navigateTo(com.ibm.rational.common.test.editor.framework.kernel.interfaces.ITargetDescriptor targetDescriptor)
Specified by:
navigateTo in interface com.ibm.rational.common.test.editor.framework.kernel.interfaces.ILayoutProvider
Overrides:
navigateTo in class ExtLayoutProvider
See Also:
ILayoutProvider.navigateTo(com.ibm.rational.common.test.editor.framework.kernel.interfaces.ITargetDescriptor)

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.