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

Class ExtLayoutProvider

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

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

Direct Known Subclasses:

DefaultTestLayoutProvider, LtLayoutProvider

public class ExtLayoutProvider
extends com.ibm.rational.common.test.editor.framework.kernel.InteractiveLayoutProvider
implements IExtensiblePrivider

Base layout provider for all editor elements (schedule, compound test, load test). This provider defines two tabs (General and Advanced), but the latter is displayed only if it has some contents. This class provides the following fields in the Advanced tab: - Always log - Requirements - Error handling

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	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.common.test.editor.framework.kernel.interfaces.ILayoutProvider

CTRL_NAME

Constructor Summary

Constructors

Constructor and Description
ExtLayoutProvider()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addAdvancedLogUi(Composite parent)
void	beforeHide(boolean isNewType)
protected void	createAdvancedControls(Composite tabbedAdvanced) This implementation calls #createRequirements() to display set of requirements, if any.
protected com.ibm.rational.common.test.editor.framework.extensions.AdvancedLogUI	createAdvancedLogUi()
protected void	createExceptionHandling(Composite parent, com.ibm.rational.common.test.editor.framework.extensions.ExceptionsUI exceptionsUI)
protected com.ibm.rational.common.test.editor.framework.extensions.ExceptionsUI	createExceptionsUi()
protected void	createRequirements(Composite parent, com.ibm.rational.common.test.editor.framework.extensions.RequirementsUI requirementsUI)
protected com.ibm.rational.common.test.editor.framework.extensions.RequirementsUI	createRequirementsUi()
protected SashForm	createSashForm() Creates a SashForm dividing the pane.
protected Composite	createSashFormBlock(Composite sform, int colorid)
protected Composite	createScrolledComposite(Composite parent, String helpId)
void	dispose()
void	enableComposite(Composite group, boolean enable)
protected void	fixSashColors(int[] weights, SashForm sform)
Composite	getAdvancedTabbed()
protected String	getAdvancedTabHelpId() Returns the Context Help ID for the Advanced tab.
protected IConfigurationElement	getConfigElem()
Composite	getDetails()
protected String	getGeneralTabHelpId() Returns the Context Help ID for the General tab.
com.ibm.rational.common.test.editor.framework.kernel.interfaces.IMultiSelectLayoutProvider	getMultiSelectLayoutProvider()
protected com.ibm.rational.common.test.editor.framework.extensions.RequirementsUI	getReqUi()
protected CTabFolder	getTabFolder()
protected StyledText	getTextField(String fieldName)
protected int	getTopMargin()
void	initialize(com.ibm.rational.common.test.editor.framework.kernel.interfaces.ITestEditorExtensionContext context)
protected void	initTabs()
boolean	isInitialized()
boolean	isShowAdvancedTab()
boolean	isShowExceptionHandlingUi()
void	keyReleased(KeyEvent e)
boolean	layoutControls(CBActionElement selectedElement) Implementing classes should override and provide UI for editing.
void	modifyText(ModifyEvent e) Default implementation calls @link ExtLayoutProvider#objectChanged(TypedEvent)
void	mouseDoubleClick(MouseEvent e)
boolean	navigateTo(com.ibm.rational.common.test.editor.framework.kernel.interfaces.ITargetDescriptor targetDescriptor)
void	objectChanged(Object context) This method is called after model object was modified in some way by user.
void	reflow(boolean flushCache) when required to update scrollbar you should call this
boolean	refreshControls(CBActionElement selectedElement) Implementing classes should override and provide UI for editing.
protected void	refreshDescription(CBActionElement selectedElement) Deprecated.
void	refreshRequirements()
void	setDetails(Composite i_composite)
Control	setFocusTo(String fieldName, int cursorPos, int selectionLen)
void	setInitializationData(IConfigurationElement config, String propertyName, Object data)
void	setInitialized(boolean initialized) This method is called by editor kernel after the first call to layoutProvider.
protected void	setReqUi(com.ibm.rational.common.test.editor.framework.extensions.RequirementsUI reqUi)
void	setSelection(Object selection)
boolean	setTabVisible(boolean advanced)
void	widgetSelected(SelectionEvent e) Default implementation calls @link ExtLayoutProvider#objectChanged(TypedEvent)

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

Constructor Detail

ExtLayoutProvider

public ExtLayoutProvider()

Method Detail

initialize

public void initialize(com.ibm.rational.common.test.editor.framework.kernel.interfaces.ITestEditorExtensionContext context)

Overrides:

initialize in class com.ibm.rational.common.test.editor.framework.kernel.AbstractLayoutProvider

setDetails

public void setDetails(Composite i_composite)

Specified by:

setDetails in interface com.ibm.rational.common.test.editor.framework.kernel.interfaces.ILayoutProvider

Overrides:

setDetails in class com.ibm.rational.common.test.editor.framework.kernel.AbstractLayoutProvider

getTabFolder

protected CTabFolder getTabFolder()

getDetails

public Composite getDetails()

Overrides:

getDetails in class com.ibm.rational.common.test.editor.framework.kernel.AbstractLayoutProvider

createScrolledComposite

protected Composite createScrolledComposite(Composite parent,
                                String helpId)

getTopMargin

protected int getTopMargin()

initTabs

protected void initTabs()

reflow

public void reflow(boolean flushCache)

when required to update scrollbar you should call this

getGeneralTabHelpId

protected String getGeneralTabHelpId()

Returns the Context Help ID for the General tab. This implementation returns the last segment of the element type handled by this layout provider.

getAdvancedTabHelpId

protected String getAdvancedTabHelpId()

Returns the Context Help ID for the Advanced tab. This implementation returns the same ID as ExtLayoutProvider.getGeneralTabHelpId().

Returns:

the Context Help ID for the Advanced tab.

setInitializationData

public void setInitializationData(IConfigurationElement config,
                         String propertyName,
                         Object data)
                           throws CoreException

Specified by:

setInitializationData in interface IExecutableExtension

Overrides:

setInitializationData in class com.ibm.rational.common.test.editor.framework.kernel.InteractiveLayoutProvider

Throws:

CoreException

isShowExceptionHandlingUi

public boolean isShowExceptionHandlingUi()

isShowAdvancedTab

public boolean isShowAdvancedTab()

setTabVisible

public boolean setTabVisible(boolean advanced)

getMultiSelectLayoutProvider

public com.ibm.rational.common.test.editor.framework.kernel.interfaces.IMultiSelectLayoutProvider getMultiSelectLayoutProvider()

Overrides:

getMultiSelectLayoutProvider in class com.ibm.rational.common.test.editor.framework.kernel.AbstractLayoutProvider

layoutControls

public boolean layoutControls(CBActionElement selectedElement)

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

Parameters:

selectedElement - CBActionElement

Returns:

boolean true. .

See Also:

com.ibm.rational.common.editor.framework.kernel.interfaces.ILayoutProvider#layoutControls(org.eclipse.jface.viewers.StructuredSelection)

createAdvancedControls

protected void createAdvancedControls(Composite tabbedAdvanced)

This implementation calls #createRequirements() to display set of requirements, if any.

Subclasses may override this method to add more UI in advanced Tab, but are expected to call super.

The Advanced Tab may be hidden for certain elements if showAdvancedTab attribute of com.ibm.rational.test.common.editor.framework.modelObjectDescriptor#layoutProvideris set to false. If this is the case, this method will not be called.

Parameters:

tabbedAdvanced - Composite in the Advanced Tab.

See Also:

#createNameAndDescription()

createExceptionsUi

protected com.ibm.rational.common.test.editor.framework.extensions.ExceptionsUI createExceptionsUi()

createExceptionHandling

protected void createExceptionHandling(Composite parent,
                           com.ibm.rational.common.test.editor.framework.extensions.ExceptionsUI exceptionsUI)

createRequirementsUi

protected com.ibm.rational.common.test.editor.framework.extensions.RequirementsUI createRequirementsUi()

createRequirements

protected void createRequirements(Composite parent,
                      com.ibm.rational.common.test.editor.framework.extensions.RequirementsUI requirementsUI)

addAdvancedLogUi

protected void addAdvancedLogUi(Composite parent)

createAdvancedLogUi

protected com.ibm.rational.common.test.editor.framework.extensions.AdvancedLogUI createAdvancedLogUi()

refreshControls

public boolean refreshControls(CBActionElement selectedElement)

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

Returns:

boolean true.

See Also:

com.ibm.rational.common.editor.framework.kernel.interfaces.ILayoutProvider#refreshControls(org.eclipse.jface.viewers.StructuredSelection)

refreshRequirements

public void refreshRequirements()

refreshDescription

@Deprecated
protected void refreshDescription(CBActionElement selectedElement)

Deprecated.

This method is not used any more by the framework (the description is not displayed).

Parameters:

selectedElement -

keyReleased

public void keyReleased(KeyEvent e)

Specified by:

keyReleased in interface KeyListener

Overrides:

keyReleased in class com.ibm.rational.common.test.editor.framework.kernel.InteractiveLayoutProvider

mouseDoubleClick

public void mouseDoubleClick(MouseEvent e)

Specified by:

mouseDoubleClick in interface MouseListener

Overrides:

mouseDoubleClick in class com.ibm.rational.common.test.editor.framework.kernel.InteractiveLayoutProvider

dispose

public void dispose()

Overrides:

dispose in class com.ibm.rational.common.test.editor.framework.kernel.InteractiveLayoutProvider

enableComposite

public void enableComposite(Composite group,
                   boolean enable)

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

setFocusTo

public Control setFocusTo(String fieldName,
                 int cursorPos,
                 int selectionLen)

Specified by:

setFocusTo in interface com.ibm.rational.common.test.editor.framework.kernel.interfaces.ILayoutProvider

getTextField

protected StyledText getTextField(String fieldName)

Parameters:

fieldName -

Returns:

StyledText

getConfigElem

protected IConfigurationElement getConfigElem()

Returns:

Returns the conElem.

createSashForm

protected SashForm createSashForm()

Creates a SashForm dividing the pane.

createSashFormBlock

protected Composite createSashFormBlock(Composite sform,
                            int colorid)

Parameters:

sform -

colorid - This argument is used for debugging only.

Returns:

fixSashColors

protected void fixSashColors(int[] weights,
                 SashForm sform)

objectChanged

public void objectChanged(Object context)

This method is called after model object was modified in some way by user. Clients should overide this method if more complex update is required.

This method does the following:

   ModelStateManager.setStatusModified((CBActionElement)getSelection(), event.getSource(), getTestEditor());
   updateTreeView();
   getTestEditor().markDirty();
 

Parameters:

context - user context Object

modifyText

public void modifyText(ModifyEvent e)

Default implementation calls @link ExtLayoutProvider#objectChanged(TypedEvent)

Specified by:

modifyText in interface ModifyListener

Overrides:

modifyText in class com.ibm.rational.common.test.editor.framework.kernel.InteractiveLayoutProvider

See Also:

ModifyListener.modifyText(org.eclipse.swt.events.ModifyEvent)

widgetSelected

public void widgetSelected(SelectionEvent e)

Default implementation calls @link ExtLayoutProvider#objectChanged(TypedEvent)

Specified by:

widgetSelected in interface SelectionListener

Overrides:

widgetSelected in class com.ibm.rational.common.test.editor.framework.kernel.InteractiveLayoutProvider

See Also:

SelectionListener.widgetSelected(org.eclipse.swt.events.SelectionEvent)

beforeHide

public void beforeHide(boolean isNewType)

Specified by:

beforeHide in interface com.ibm.rational.common.test.editor.framework.kernel.interfaces.ILayoutProvider2

Overrides:

beforeHide in class com.ibm.rational.common.test.editor.framework.kernel.InteractiveLayoutProvider

setSelection

public void setSelection(Object selection)

Overrides:

setSelection in class com.ibm.rational.common.test.editor.framework.kernel.AbstractLayoutProvider

setInitialized

public void setInitialized(boolean initialized)

This method is called by editor kernel after the first call to layoutProvider. Clients should not call this method directly.

Overrides:

setInitialized in class com.ibm.rational.common.test.editor.framework.kernel.AbstractLayoutProvider

isInitialized

public boolean isInitialized()

Overrides:

isInitialized in class com.ibm.rational.common.test.editor.framework.kernel.AbstractLayoutProvider

getAdvancedTabbed

public Composite getAdvancedTabbed()

getReqUi

protected com.ibm.rational.common.test.editor.framework.extensions.RequirementsUI getReqUi()

setReqUi

protected void setReqUi(com.ibm.rational.common.test.editor.framework.extensions.RequirementsUI reqUi)