|
IBM Rational Software Modeler Release 6.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.xtools.transform.ui.internal.dialogs.BaseTransformConfigTab
com.ibm.xtools.transform.ui.AbstractTransformConfigTab
The Abstract Transform Config Tab is the base class for all tabs that are shown in the Transformation Configuration Manager. Each tab represents some customizable functionality for the given transformation. The data provided by the tab is stored as properties in a transformation context. This makes that data available to the transformation elements during execution.
The transformation UI also requires the tab's data to be persisted and the save/restore mechanism uses a string to save the data. The format of that persisted data string is up to the tab itself but is usually a list of name/value pairs.
Constructor Summary | |
AbstractTransformConfigTab(ITransformationDescriptor transDesc,
String tabId,
String label)
Constructor for a transform configuration tab |
Method Summary | |
abstract Control |
createContents(Composite parent)
Create the contents (controls) for the tab. |
void |
dispose()
This method is called when the tab is being displosed. |
protected ITransformContext |
getCurrentTransformContext()
Construct a transform context from the information currently displayed in the GUI. |
abstract String |
getTabData()
Return the current tab information. |
abstract void |
populateContext(ITransformContext context,
String info)
Populate the transform context based on the supplied data string. |
protected void |
setDirty()
Indicate that the contents of the tab is dirty and requires an apply. |
protected void |
setErrorMessage(String message)
Set an error message in the dialog's UI. |
protected void |
setMessage(String message)
Set a message (the title) in the dialog's UI. |
abstract void |
setTabData(String newInfo)
Update the tab's controls with the given data. |
Methods inherited from class com.ibm.xtools.transform.ui.internal.dialogs.BaseTransformConfigTab |
getErrorMessage, getLabel, getMessage, getTabId, getTransformationDescriptor, isDirty |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public AbstractTransformConfigTab(ITransformationDescriptor transDesc, String tabId, String label)
transDesc
- the ITransformationDescriptor the tab is fortabId
- a unique identifier for this tablabel
- the localized label to be displayed on the tabMethod Detail |
public abstract Control createContents(Composite parent)
parent
- The Composite into which to create the tab's controls
public abstract void setTabData(String newInfo)
newInfo
- The string containing the new information to displaypublic abstract String getTabData()
public abstract void populateContext(ITransformContext context, String info)
context
- The transformation execute context to populateinfo
- The string containing the formatted data for the tabpublic void dispose()
protected final void setDirty()
BaseTransformConfigTab.setDirty()
protected final void setMessage(String message)
message
- - the message that describes the tab's purposeprotected final void setErrorMessage(String message)
message
- - the message that describes the errorprotected final ITransformContext getCurrentTransformContext()
This method is meant to be used ONLY when the Configure or Run dialog is being displayed and must not be called inside the 'populateContext' method (which will cause a recursion).
|
IBM Rational Software Modeler Release 6.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2004. All rights reserved.