|
IBM Rational Performance Tester SDK | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.rational.common.test.editor.framework.TestEditor
public abstract class TestEditor
Field Summary | |
---|---|
protected static String |
LASTFIELDSELECTION
|
protected static String |
LASTSELECTION
|
static byte |
VIEW_MODE_NORMAL
|
Fields inherited from interface com.ibm.rational.common.test.editor.framework.kernel.actions.ITestEditorActionIDs |
---|
ACTION_GROUP_EDIT_END, ACTION_GROUP_EDIT_START, ACTION_GROUP_FILTERS_END, ACTION_GROUP_FILTERS_START, ACTION_GROUP_FIND_END, ACTION_GROUP_FIND_START, ACTION_GROUP_GOTO_END, ACTION_GROUP_GOTO_START, ACTION_GROUP_MODIFY_CONTRIBUTIONS_END, ACTION_GROUP_MODIFY_CONTRIBUTIONS_START, ACTION_GROUP_NEW_END, ACTION_GROUP_NEW_START, ACTION_GROUP_SHOW_END, ACTION_GROUP_SHOW_START, COPY, CUT, DELETE, PASTE, SAVE, SELECT_ALL |
Fields inherited from interface com.ibm.rational.common.test.editor.framework.kernel.interfaces.ILoggingConstants |
---|
RPCA0100W, RPCA0101W, RPCA0102W, RPCA0103W, RPCA0104W, RPCA0105E, RPCA0106E, RPCA0107E, RPCA0108E, RPCA0109E, RPCA0110E, RPCA1001E, RPCA1001W, RPCA1002E |
Constructor Summary | |
---|---|
TestEditor(CommonEditorExtension ext)
TestEditor create an instance of this object from your EditorExtension.createPages method. |
Method Summary | |
---|---|
void |
aboutToRun(IJobChangeEvent event)
|
void |
activate(boolean active)
|
protected void |
addAvailableType(List<CBActionElement> list)
|
void |
addAvailableType(String type)
|
void |
addRecentSearchText(String text)
|
void |
awake(IJobChangeEvent event)
|
void |
cancelCutOperation()
Convenience method for cancelling active Cut operation. |
void |
clearDirty()
Clears editor's dirty state. |
boolean |
confirmRemove(IStructuredSelection ssel,
String name)
|
boolean |
confirmRemove(IStructuredSelection ssel,
String name,
int maxInList)
|
protected void |
connectToEclipse(IEditorPart part)
|
void |
create()
Creates editor contents. |
protected LoadTestEditorForm |
createEditorForm()
Creates and returns EditorForm |
abstract com.ibm.rational.common.test.editor.framework.extensions.ExceptionsUI |
createExceptionsUI(ExtLayoutProvider provider)
|
protected RptMenuManager |
createMenuManager()
|
abstract CBTest |
createTestObject()
Loads and returns concrete type derived from CBTest . |
void |
displayMatch(Object match)
Displays Search Match. |
void |
displayObject(com.ibm.rational.common.test.editor.framework.kernel.interfaces.ITargetDescriptor target)
Directs TestEditor to locate and select specified model element in the tree section. |
protected void |
doFirstTimeInit()
This method is called when a test is opened in th editor for the very first time. |
void |
done(IJobChangeEvent event)
|
void |
fillContextMenu(IMenuManager menu)
Fills content menu for TestEditor's MainSection |
protected void |
fixBadRequirements()
Find and disable requirement targets with all incomplete requirements |
protected String |
formatMessage(com.ibm.rational.test.common.models.behavior.exceptions.CommonModelException e1)
|
String[] |
getApplicableTypes()
Used by base editor's ExtensionContainer s to filter extensions. |
Set<String> |
getAvailableTypes()
|
com.ibm.rational.common.test.editor.framework.kernel.actions.CreateBookmarkAction |
getBookmarkAction()
|
CommonEditorExtension |
getCallingEditorExtension()
|
boolean |
getCaseSearchValue()
|
IStructuredSelection |
getCurrentSelection()
Returns current selection. |
String |
getDialogCaption(String dialogName)
|
com.ibm.rational.common.test.editor.framework.kernel.actions.DisableElementAction |
getDisableAction()
|
String |
getEditorName()
Returns editor name. |
IDialogSettings |
getEditorState()
Returns IDialogSettings with settings of this editor. |
com.ibm.rational.common.test.editor.framework.kernel.actions.EnableElementAction |
getEnableAction()
|
com.ibm.rational.common.test.editor.framework.kernel.actions.EnableAllAction |
getEnableAllAction()
|
FindReplaceAction |
getFindReplaceAction()
|
LoadTestEditorForm |
getForm()
Returns editor form. |
String |
getFormattedResourceName()
|
Image |
getImageFor(Object element)
|
String |
getLabelFor(Object element)
|
RptMenuManager |
getMenuManager()
|
com.ibm.rational.common.test.editor.framework.kernel.interfaces.ITestEditorExtensionContext |
getProviders(CBActionElement element)
Returns ITestEditorExtensionContext (providers container) for the specified CBActionElement . |
List |
getProviders(IStructuredSelection selection)
Returns ITestEditorExtensionContext s (one or more providers) for CBActionElement s contained in the
specified StructuredSelection. |
com.ibm.rational.common.test.editor.framework.kernel.interfaces.ITestEditorExtensionContext |
getProviders(String type)
Returns ITestEditorExtensionContext (providers container) for the specified type . |
List<String> |
getRecentSearches()
|
boolean |
getRegexSearchValue()
|
CBTest |
getTest()
Returns CBTest . |
ISearchQuery |
getTestSearchQuery(com.ibm.rational.common.test.editor.framework.kernel.search.QuerySpecification specs,
int what)
Returns instanceof SearchQuery . |
org.eclipse.hyades.models.common.facades.behavioral.ITestSuite |
getTestSuite()
|
byte |
getViewMode()
|
void |
gotoMarker(IMarker marker)
|
int |
hasJobs()
|
abstract void |
initHeading(com.ibm.rational.common.test.editor.framework.kernel.AbstractLoadTestEditorForm form)
|
boolean |
isHighlightSearchResults()
|
boolean |
isOkToSave()
Always returns true. |
boolean |
isReadOnly()
|
void |
jobCreated(com.ibm.rational.common.test.editor.framework.jobs.TestModifyingJob job)
|
void |
markDirty()
Marks the TestEditor as dirty. |
void |
refresh()
Refreshes details section of the element(s) currently selected in the editor tree. |
protected void |
restoreState()
Restores editor state upon load. |
void |
running(IJobChangeEvent event)
|
void |
saveState()
Saves editor state |
void |
scheduled(IJobChangeEvent event)
|
void |
selectionChanged(ISelection selection)
This method is called when selection changes in the editor's tree. |
void |
setCaseSearchValue(boolean selection)
|
protected void |
setCbTest(CBTest test)
|
void |
setEditorName(String string)
Sets editor name. |
void |
setHighlightSearchResults(boolean b)
|
void |
setInput(Object arg0)
This method is called when the test is opening in the Eclipse editor. |
void |
setReadOnly(boolean isReadOnly)
Changes editor state as read-only. |
void |
setRegexSearchValue(boolean selection)
|
void |
setStatusLineMessage(String string,
boolean isError)
Sets status line text. |
void |
setStatusLineMessage(String string,
boolean isError,
Image image)
Sets status line text and image. |
protected void |
setViewMode(byte lastViewMode,
StructuredSelection ssel)
This implementation does nothing. |
void |
sleeping(IJobChangeEvent event)
|
void |
storeFieldLocation(com.ibm.rational.common.test.editor.framework.extensions.TextAttributeField field,
int selStart,
int selEnd)
|
void |
unload(boolean reserved)
This method is called when TestEditor is being unloaded. |
void |
updateActions(com.ibm.rational.common.test.editor.framework.kernel.interfaces.ITextGlobalActionHandler handler,
Control ctrl,
ISelection selection)
|
void |
updateFindRepleceAction()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final byte VIEW_MODE_NORMAL
protected static final String LASTSELECTION
protected static final String LASTFIELDSELECTION
Constructor Detail |
---|
public TestEditor(CommonEditorExtension ext)
ext
- EditorExtensionMethod Detail |
---|
public RptMenuManager getMenuManager()
protected RptMenuManager createMenuManager()
public boolean confirmRemove(IStructuredSelection ssel, String name)
public boolean confirmRemove(IStructuredSelection ssel, String name, int maxInList)
public abstract CBTest createTestObject()
CBTest
.
protected String formatMessage(com.ibm.rational.test.common.models.behavior.exceptions.CommonModelException e1)
public String[] getApplicableTypes()
ExtensionContainer
s to filter extensions. You will want to override
this method to limit what extensions can contribute to your editor.
Default implementation returns String [] {"*"}
which will load all extensions.
public void create()
public void saveState()
protected void connectToEclipse(IEditorPart part)
site
- protected LoadTestEditorForm createEditorForm()
public CommonEditorExtension getCallingEditorExtension()
CommonEditorExtension
public org.eclipse.hyades.models.common.facades.behavioral.ITestSuite getTestSuite()
public void markDirty()
TestEditor
as dirty. Dirty editors can be saved.
org.eclipse.hyades.test.ui.internal.editor.extension.BaseEditorExtension#markDirty()
public void cancelCutOperation()
This method is called when any model element gets modified, or the model itself is modified by adding, removing, or rearranging model elements.
public void clearDirty()
org.eclipse.hyades.test.ui.internal.editor.extension.BaseEditorExtension#clearDirty()
public String getEditorName()
public String getDialogCaption(String dialogName)
public abstract void initHeading(com.ibm.rational.common.test.editor.framework.kernel.AbstractLoadTestEditorForm form)
public void setEditorName(String string)
string
- public LoadTestEditorForm getForm()
From LoadTestEditorForm
you can access EditorSection
s.
public void unload(boolean reserved)
TestEditor
is being unloaded.
reserved
- public IStructuredSelection getCurrentSelection()
Current selection is what is currently selected in the TestEditor Main (tree) section.
NOTE this method, as well as the handling of "current selection" is subject to change in the future versions if RPT Test Editor.
public CBTest getTest()
CBTest
. CBTest is base class for concreate test types, and is a root element in the
TestEditor's Tree section.
protected void setCbTest(CBTest test)
test
- public void setInput(Object arg0)
arg0
- public void displayObject(com.ibm.rational.common.test.editor.framework.kernel.interfaces.ITargetDescriptor target)
TestEditor
to locate and select specified model element in the tree section.
Optionally, ITargetDescriptor
may contain additional, more precise, information about attribute
and position within attribute of the target model element.
NOTE this mechanism is subject to chage in the future versions of TestEditor.
target
- ITargetDescriptorITargetDescriptor
,
ExtLayoutProvider.navigateTo(ITargetDescriptor)
public void displayMatch(Object match)
match
- Objectpublic void setStatusLineMessage(String string, boolean isError, Image image)
IStautsLineManager
is obtained by a call to:
IStatusLineManager slm = getCallingEditorExtension().getHyadesEditorPart().getEditorPart().getEditorSite().getActionBars().getStatusLineManager();
string
- String text for statusline.isError
- booleanimage
- Image or null
public void setStatusLineMessage(String string, boolean isError)
IStautsLineManager
is obtained by a call to:
IStatusLineManager slm = getCallingEditorExtension().getHyadesEditorPart().getEditorPart().getEditorSite().getActionBars().getStatusLineManager();
string
- String text for statusline.isError
- booleanpublic void storeFieldLocation(com.ibm.rational.common.test.editor.framework.extensions.TextAttributeField field, int selStart, int selEnd)
public void selectionChanged(ISelection selection)
NOTE: this method and the handling of current selection(s) is subject to change in the future version of Test Editor.
selection
- ISelectionprotected void restoreState()
protected void setViewMode(byte lastViewMode, StructuredSelection ssel)
lastViewMode
- byte. Editor mode.ssel
- Selection of objects to display innew mode.protected void doFirstTimeInit()
public IDialogSettings getEditorState()
IDialogSettings
with settings of this editor.
TestEditorPlugin.getEditorState(TestEditor)
public void setReadOnly(boolean isReadOnly)
CommonEditorExtension
and should not be called b
clients directly.
isReadOnly
- public boolean isReadOnly()
true
if the editor is read-only and cannot be saved, false
otherwise.public void refresh()
public void jobCreated(com.ibm.rational.common.test.editor.framework.jobs.TestModifyingJob job)
job
- public int hasJobs()
public void aboutToRun(IJobChangeEvent event)
aboutToRun
in interface IJobChangeListener
public void awake(IJobChangeEvent event)
awake
in interface IJobChangeListener
public void done(IJobChangeEvent event)
done
in interface IJobChangeListener
public void running(IJobChangeEvent event)
running
in interface IJobChangeListener
public void scheduled(IJobChangeEvent event)
scheduled
in interface IJobChangeListener
public void sleeping(IJobChangeEvent event)
sleeping
in interface IJobChangeListener
public com.ibm.rational.common.test.editor.framework.kernel.interfaces.ITestEditorExtensionContext getProviders(String type)
ITestEditorExtensionContext
(providers container) for the specified type
.
type
- String CBActionElement type.
public com.ibm.rational.common.test.editor.framework.kernel.interfaces.ITestEditorExtensionContext getProviders(CBActionElement element)
ITestEditorExtensionContext
(providers container) for the specified CBActionElement
.
element
- CBActionElement.
public List getProviders(IStructuredSelection selection)
ITestEditorExtensionContext
s (one or more providers) for CBActionElement
s contained in the
specified StructuredSelection. One provider is returned for multiple CBActionElement
s of the same type.
selection
- IStructuredSelection as obtained from tree section's TreeViewer.
public void fillContextMenu(IMenuManager menu)
menu
- IMenuManagerpublic com.ibm.rational.common.test.editor.framework.kernel.actions.CreateBookmarkAction getBookmarkAction()
public void gotoMarker(IMarker marker)
gotoMarker
in interface IGotoMarker
public void activate(boolean active)
public boolean isOkToSave()
protected void fixBadRequirements()
public String getFormattedResourceName()
public void updateFindRepleceAction()
public final FindReplaceAction getFindReplaceAction()
public void updateActions(com.ibm.rational.common.test.editor.framework.kernel.interfaces.ITextGlobalActionHandler handler, Control ctrl, ISelection selection)
public ISearchQuery getTestSearchQuery(com.ibm.rational.common.test.editor.framework.kernel.search.QuerySpecification specs, int what)
SearchQuery
. Extensing classes may override and return null
if no search is supported, or some more specialized query. When this method is called from SearchPage
,
the second argument is QuerySpecification.QUERY_TYPE_DEFALT
.
specs
- QuerySpecification
query specificationint
- what An application defined flag telling the method what query to return or QuerySpecification.QUERY_TYPE_DEFALT
public com.ibm.rational.common.test.editor.framework.kernel.actions.EnableElementAction getEnableAction()
public com.ibm.rational.common.test.editor.framework.kernel.actions.DisableElementAction getDisableAction()
public com.ibm.rational.common.test.editor.framework.kernel.actions.EnableAllAction getEnableAllAction()
public String getLabelFor(Object element)
element
-
public Image getImageFor(Object element)
element
-
public final Set<String> getAvailableTypes()
public void addAvailableType(String type)
protected void addAvailableType(List<CBActionElement> list)
public byte getViewMode()
public boolean getRegexSearchValue()
public boolean getCaseSearchValue()
public void setCaseSearchValue(boolean selection)
public void setRegexSearchValue(boolean selection)
public List<String> getRecentSearches()
public void addRecentSearchText(String text)
public boolean isHighlightSearchResults()
public void setHighlightSearchResults(boolean b)
public abstract com.ibm.rational.common.test.editor.framework.extensions.ExceptionsUI createExceptionsUI(ExtLayoutProvider provider)
|
IBM Rational Performance Tester SDK | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |