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

Class DefaultTestLayoutProvider

java.lang.Object

com.ibm.rational.common.test.editor.framework.kernel.AbstractLayoutProvider

com.ibm.rational.common.test.editor.framework.kernel.InteractiveLayoutProvider

com.ibm.rational.common.test.editor.framework.extensions.ExtLayoutProvider

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, EventListener, IExecutableExtension, KeyListener, ModifyListener, MouseListener, SelectionListener, SWTEventListener, IHyperlinkListener

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

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
DefaultTestLayoutProvider()

Method Summary

Methods

Modifier and Type	Method and Description
protected com.ibm.rational.ttt.common.protocols.ui.stack.IStackedContent	createStackedContent(FormToolkit toolkit, com.ibm.rational.ttt.common.protocols.ui.stack.IStackedContentProvider contentProvider)
Composite	drawBottomPart(Composite parent, boolean sNew)
protected void	drawOptions(boolean sNew)
<T extends com.ibm.rational.common.test.editor.framework.kernel.interfaces.IOptionsHandler> T	getOptionsHandler(Class<T> handlerClass) Returns one option handler that is an instance of the specified class.
protected int	getTabLinksThreshold() Returns minimum number of optons tabs for which no links need to be drawn.
protected int	getTopMargin()
protected boolean	isControlCreated()
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.
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.
void	updateOptionsTabs()

Methods inherited from class com.ibm.rational.common.test.editor.framework.extensions.ExtLayoutProvider

addAdvancedLogUi, beforeHide, createAdvancedControls, createAdvancedLogUi, createExceptionHandling, createExceptionsUi, createRequirements, createRequirementsUi, createSashForm, createSashFormBlock, createScrolledComposite, dispose, enableComposite, fixSashColors, getAdvancedTabbed, getAdvancedTabHelpId, getConfigElem, getDetails, getGeneralTabHelpId, getMultiSelectLayoutProvider, getReqUi, getTabFolder, getTextField, initialize, initTabs, isInitialized, isShowAdvancedTab, isShowExceptionHandlingUi, keyReleased, modifyText, mouseDoubleClick, objectChanged, reflow, refreshDescription, refreshRequirements, 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, flushCachedData, getControl, getCtrlName, getCurrentField, getField, getLastField, hidden, isForceUpdate, keyPressed, linkActivated, 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

getFactory, getSelection, getTestEditor, getToolkit, 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

Methods inherited from interface org.eclipse.swt.events.KeyListener

keyPressedAdapter, keyReleasedAdapter

Methods inherited from interface org.eclipse.swt.events.MouseListener

mouseDoubleClickAdapter, mouseDownAdapter, mouseUpAdapter

Methods inherited from interface org.eclipse.swt.events.SelectionListener

widgetDefaultSelectedAdapter, widgetSelectedAdapter

Field Detail

_OPTIONS_ID

public static String _OPTIONS_ID

Constructor Detail

DefaultTestLayoutProvider

public DefaultTestLayoutProvider()

Method Detail

getOptionsHandler

public <T extends com.ibm.rational.common.test.editor.framework.kernel.interfaces.IOptionsHandler> T getOptionsHandler(Class<T> handlerClass)

Returns one option handler that is an instance of the specified class.

Type Parameters:

T -

Parameters:

handlerClass -

Returns:

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

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(boolean sNew)

updateOptionsTabs

public void updateOptionsTabs()

drawBottomPart

public Composite drawBottomPart(Composite parent,
                       boolean sNew)

Parameters:

parent -

Returns:

true if there was anything to display, false otherwise.

getTopMargin

protected int getTopMargin()

Overrides:

getTopMargin in class ExtLayoutProvider

createStackedContent

protected com.ibm.rational.ttt.common.protocols.ui.stack.IStackedContent createStackedContent(FormToolkit toolkit,
                                                                                  com.ibm.rational.ttt.common.protocols.ui.stack.IStackedContentProvider contentProvider)

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.

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)

isControlCreated

protected boolean isControlCreated()

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