IBM Rational Performance Tester SDK

com.ibm.rational.test.lt.testeditor.main.providers
Class LtLayoutProvider

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.test.lt.testeditor.main.providers.LtLayoutProvider
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, com.ibm.rational.common.test.editor.framework.search.ICommonSearchFieldNames, com.ibm.rational.test.lt.testeditor.search.ISearchFieldNames, EventListener, IExecutableExtension, org.eclipse.hyades.test.ui.editor.form.base.IHyperlinkListener, KeyListener, ModifyListener, MouseListener, SelectionListener, org.eclipse.swt.internal.SWTEventListener

public class LtLayoutProvider
extends ExtLayoutProvider
implements com.ibm.rational.test.lt.testeditor.search.ISearchFieldNames

This class should be used by any downstream protocol extensions that wish to create LayoutProvider handlers. This class provdes some useful behavior shared between all layout providers.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.ibm.rational.common.test.editor.framework.extensions.ExtLayoutProvider
ExtLayoutProvider.ExpandBlockAction
 
Field Summary
 
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.test.lt.testeditor.search.ISearchFieldNames
_FIELD_CONTENT_VP_STRING, _FIELD_CUSTOM_CODE_ARGS, _FIELD_CUSTOM_CODE_NAME, _FIELD_CVP_BYTES, _FIELD_CVP_TEXT, _FIELD_IF_LEFT_OP, _FIELD_IF_RIGHT_OP, _FIELD_TRANS_NAME
 
Fields inherited from interface com.ibm.rational.common.test.editor.framework.search.ICommonSearchFieldNames
_FIELD_COMMENT, _FIELD_DELAY_TIME, _FIELD_DESC, _FIELD_LOOP_COND_ITER, _FIELD_LOOP_COND_TIMED, _FIELD_LOOP_NAME, _FIELD_LOOP_PACING_RATE, _FIELD_NAME, _FIELD_RANDOM_SELECTOR, _FIELD_WEIGHTED_BLOCK, _PREFIX
 
Fields inherited from interface com.ibm.rational.common.test.editor.framework.kernel.interfaces.ILayoutProvider
CTRL_NAME
 
Constructor Summary
LtLayoutProvider()
           
 
Method Summary
protected  void createAdvancedControls(Composite tabbedAdvanced)
          This implementation first calls the super.createAdvancedControls(Composite)} and then adds the UI required to display transformations, if applicable to a given model element.
protected  void createTransform(Composite tabbedAdvanced)
          Creates UI required to display and manipulate applied transforms.
 ControlDecoration decorateForTransform(Object ctrlOrDecoration)
           
protected  String getDataTransformationLabel()
           
protected  String getTransformID()
           
protected  boolean hasApplicableTransforms()
          Calls AdapterElementHandler to check if given model element is transformable (i.e. if any transforms recognize this element)
 boolean layoutControls(CBActionElement selectedElement)
          Implementing classes should override and provide UI for editing.
protected  boolean onChangeTransform()
          Transform had changed.
 boolean refreshControls(CBActionElement selectedElement)
          Implementing classes should override and provide UI for editing.
protected  void updateArmTagUI(boolean isNew)
          This method is called from LtLayoutProvider.layoutControls(CBActionElement) and LtLayoutProvider.refreshControls(CBActionElement).
 
Methods inherited from class com.ibm.rational.common.test.editor.framework.extensions.ExtLayoutProvider
beforeHide, createAlwaysLogUi, createExceptionHandling, createExceptionsUi, createRequirements, createRequirementsUi, createSashForm, createSashFormBlock, enableComposite, fixSashColors, flushCachedData, getAdvancedTabbed, getConfigElem, getDetails, getMultiSelectLayoutProvider, getReqUi, getTextField, isInitialized, isShowAdvancedTab, isShowExceptionHandlingUi, keyReleased, modifyText, mouseDoubleClick, navigateTo, 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, linkActivated, 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
 

Constructor Detail

LtLayoutProvider

public LtLayoutProvider()
Method Detail

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)

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)

updateArmTagUI

protected void updateArmTagUI(boolean isNew)
This method is called from LtLayoutProvider.layoutControls(CBActionElement) and LtLayoutProvider.refreshControls(CBActionElement). If an object returned from AbstractLayoutProvider.getSelection() implements LTArmEnabled, the checkbox will be displayed and updated.

Parameters:
isNew. - true if called from layoutControls and false if called from refreshControls.

createAdvancedControls

protected void createAdvancedControls(Composite tabbedAdvanced)
This implementation first calls the super.createAdvancedControls(Composite)} and then adds the UI required to display transformations, if applicable to a given model element.

Overrides:
createAdvancedControls in class ExtLayoutProvider
Parameters:
tabbedAdvanced - Composite in the Advanced Tab.
See Also:
ExtLayoutProvider.createAdvancedControls(org.eclipse.swt.widgets.Composite)

hasApplicableTransforms

protected boolean hasApplicableTransforms()
Calls AdapterElementHandler to check if given model element is transformable (i.e. if any transforms recognize this element)

Returns:
true if element can be transformed and the UI for selecting transforms is needed.
See Also:
LtLayoutProvider.createTransform(Composite)

createTransform

protected void createTransform(Composite tabbedAdvanced)
Creates UI required to display and manipulate applied transforms. Cleints are expected not to overwrite this method. It has protected attribute only so multiselect layout provider can handle requirements of multiple elements.

Parameters:
tabbedAdvanced - Composite parent in Advanced Tab.

getDataTransformationLabel

protected String getDataTransformationLabel()

decorateForTransform

public ControlDecoration decorateForTransform(Object ctrlOrDecoration)

onChangeTransform

protected boolean onChangeTransform()
Transform had changed. Clients are expected not to override this method.


getTransformID

protected String getTransformID()

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.