TPTP 4.4.0 Testing Tools Project
Internal API Specification

org.eclipse.tptp.test.auto.gui.internal.editor
Class AutoGUITestCasesForm

java.lang.Object
  extended byorg.eclipse.core.commands.common.EventManager
      extended byorg.eclipse.ui.part.WorkbenchPart
          extended byorg.eclipse.ui.part.EditorPart
              extended byorg.eclipse.ui.forms.editor.FormPage
                  extended byorg.eclipse.hyades.test.ui.internal.editor.form.util.EditorEclipseForm
                      extended byorg.eclipse.hyades.test.tools.ui.common.internal.editor.TestCasesEclipseForm
                          extended byorg.eclipse.tptp.test.auto.gui.internal.editor.AutoGUITestCasesForm
All Implemented Interfaces:
org.eclipse.core.runtime.IAdaptable, org.eclipse.ui.IEditorPart, org.eclipse.core.runtime.IExecutableExtension, org.eclipse.ui.forms.editor.IFormPage, IITestSuiteProvider, org.eclipse.ui.ISaveablePart, org.eclipse.jface.viewers.ISelectionChangedListener, org.eclipse.ui.texteditor.ITextEditorExtension2, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.IWorkbenchPart3, org.eclipse.ui.part.IWorkbenchPartOrientation

public class AutoGUITestCasesForm
extends TestCasesEclipseForm
implements org.eclipse.ui.texteditor.ITextEditorExtension2

This form provides the 'macro-examine' page that allows users to easily navigate through a macro and make the appropriate adjustments.


Nested Class Summary
static class AutoGUITestCasesForm.GUITestCaseProperties
          Extended properties on GUI test cases.
static interface AutoGUITestCasesForm.IMacroModifyListener
          Entities that wish to register a modify listener with the macro text area must implement this interface.
 class AutoGUITestCasesForm.LogicalRepresentationListener
          The selection listener for the logical tree representation of the macro
static class AutoGUITestCasesForm.MacroFindReplaceTarget
          The Macro find/replace targe.
 class AutoGUITestCasesForm.ObjectMineTreeListener
          The selection listener for the logical tree representation of the macro
 
Field Summary
protected static int UNDO_OPERATION_LIMIT
           
 
Fields inherited from class org.eclipse.hyades.test.tools.ui.common.internal.editor.TestCasesEclipseForm
HELP_DETAIL_SECTION_CONTROL, HELP_NAMED_ELEMENT_CONTROL, HELP_TEST_CASES_SECTION_CONTROL, HELP_TEST_CASES_SECTION_TREE_CONTROL
 
Fields inherited from interface org.eclipse.ui.IEditorPart
PROP_DIRTY, PROP_INPUT
 
Fields inherited from interface org.eclipse.ui.IWorkbenchPart
PROP_TITLE
 
Constructor Summary
AutoGUITestCasesForm(org.eclipse.hyades.ui.editor.IEditorExtension editor, java.lang.String id, java.lang.String title)
           
 
Method Summary
 void addProperty(org.eclipse.hyades.models.common.facades.behavioral.ITestCase testCase, byte field, java.lang.String value)
          Adds extended properties to test cases
protected  void createFormContent(org.eclipse.ui.forms.IManagedForm managedForm)
          This method is over-written to re-organize controls based on a different layout than the one that the parent class provides.
protected  void createLeftColumnControls(org.eclipse.swt.widgets.Composite parent)
          Create the left column controls for this form
protected  void createRightColumnControls(org.eclipse.swt.widgets.Composite parent)
          The right column controls of the page are created by this method
 void dispose()
           
 java.lang.Object getAdapter(java.lang.Class adapter)
           
 org.eclipse.ui.forms.widgets.ScrolledForm getForm()
           
 AutoGUITestCasesForm.LogicalRepresentationListener getLogicalRepresentationListener()
           
 AutoGUITestCaseTreeStructure getLogicalTreeRepresentaion()
           
 AutoGUIObjectMineTreeStructure getObjectMineTreeStruct()
           
 java.lang.String getProperty(org.eclipse.hyades.models.common.facades.behavioral.ITestCase testCase, byte field)
           
 org.eclipse.swt.custom.StyledText getRawRepresentation()
           
 org.eclipse.swt.custom.SashForm getSashForm()
           
 boolean isEditorInputModifiable()
          This needs to return true in order to enable the replace option of the the find dialog.
 void refresh()
          Refreshes the test case tree and the object mine tree owned by this form.
 void setActive(boolean active)
           
 boolean updateTestProperty(java.lang.String oldValue, java.lang.String newValue, boolean isObjectMine)
           
 boolean validateEditorInputState()
           
 
Methods inherited from class org.eclipse.hyades.test.tools.ui.common.internal.editor.TestCasesEclipseForm
addCustomButtons, buttonsCreated, createCommonPropertySection, createDetailPropertySection, createTestCaseSection, getAddTestCaseAction, getCommonSection, getCurrentSelection, getEnableStatus, getEobjectTree, getStanderdControlIndices, getTestSuite, registerHelp, selectionChanged, setStandardControlIndices, toggleEnableStatus, toggleEnableStatus, toggleStdButtonEnableStatus
 
Methods inherited from class org.eclipse.hyades.test.ui.internal.editor.form.util.EditorEclipseForm
activated, addDetails, createColumn, getCommonTestSuite, getEditorTitle, getFormEditor, markEditorDirty, updateTitle
 
Methods inherited from class org.eclipse.ui.forms.editor.FormPage
canLeaveThePage, createPartControl, doSave, doSaveAs, getEditor, getId, getIndex, getManagedForm, getPartControl, getTitleImage, init, initialize, isActive, isDirty, isEditor, isSaveAsAllowed, selectReveal, setFocus, setIndex
 
Methods inherited from class org.eclipse.ui.part.EditorPart
checkSite, getEditorInput, getEditorSite, getTitleToolTip, isSaveOnCloseNeeded, setContentDescription, setInitializationData, setInput, setInputWithNotify, setPartName
 
Methods inherited from class org.eclipse.ui.part.WorkbenchPart
addPartPropertyListener, addPropertyListener, firePartPropertyChanged, firePropertyChange, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, removePartPropertyListener, removePropertyListener, setPartProperty, setSite, setTitle, setTitleImage, setTitleToolTip, showBusy
 
Methods inherited from class org.eclipse.core.commands.common.EventManager
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.ui.IEditorPart
getEditorInput, getEditorSite
 
Methods inherited from interface org.eclipse.ui.IWorkbenchPart
addPropertyListener, getSite, getTitle, getTitleToolTip, removePropertyListener
 
Methods inherited from interface org.eclipse.ui.ISaveablePart
isSaveOnCloseNeeded
 

Field Detail

UNDO_OPERATION_LIMIT

protected static final int UNDO_OPERATION_LIMIT
See Also:
Constant Field Values
Constructor Detail

AutoGUITestCasesForm

public AutoGUITestCasesForm(org.eclipse.hyades.ui.editor.IEditorExtension editor,
                            java.lang.String id,
                            java.lang.String title)
Method Detail

createRightColumnControls

protected void createRightColumnControls(org.eclipse.swt.widgets.Composite parent)
Description copied from class: EditorEclipseForm
The right column controls of the page are created by this method

Overrides:
createRightColumnControls in class TestCasesEclipseForm

createLeftColumnControls

protected void createLeftColumnControls(org.eclipse.swt.widgets.Composite parent)
Description copied from class: TestCasesEclipseForm
Create the left column controls for this form

Overrides:
createLeftColumnControls in class TestCasesEclipseForm
Parameters:
parent - The parent composite

createFormContent

protected void createFormContent(org.eclipse.ui.forms.IManagedForm managedForm)
This method is over-written to re-organize controls based on a different layout than the one that the parent class provides. This form is divided into two horizontal panes that can be resized. The upper pane provides a logical tree view of the macro whereas the lower pane provides the raw XML macro.

Overrides:
createFormContent in class TestCasesEclipseForm

setActive

public void setActive(boolean active)
Specified by:
setActive in interface org.eclipse.ui.forms.editor.IFormPage

refresh

public void refresh()
Refreshes the test case tree and the object mine tree owned by this form.


getRawRepresentation

public org.eclipse.swt.custom.StyledText getRawRepresentation()

dispose

public void dispose()
Specified by:
dispose in interface org.eclipse.ui.IWorkbenchPart
Overrides:
dispose in class TestCasesEclipseForm
See Also:
org.eclipse.update.ui.forms.internal.IForm#dispose()

addProperty

public void addProperty(org.eclipse.hyades.models.common.facades.behavioral.ITestCase testCase,
                        byte field,
                        java.lang.String value)
Adds extended properties to test cases

Parameters:
testCase - The test case
field - The field to be added - see constants in GUITestCaseProperties
value - The value of the field

getProperty

public java.lang.String getProperty(org.eclipse.hyades.models.common.facades.behavioral.ITestCase testCase,
                                    byte field)

getObjectMineTreeStruct

public AutoGUIObjectMineTreeStructure getObjectMineTreeStruct()

updateTestProperty

public boolean updateTestProperty(java.lang.String oldValue,
                                  java.lang.String newValue,
                                  boolean isObjectMine)

getLogicalTreeRepresentaion

public AutoGUITestCaseTreeStructure getLogicalTreeRepresentaion()
Returns:
the logicalTreeRepresentaion

getLogicalRepresentationListener

public AutoGUITestCasesForm.LogicalRepresentationListener getLogicalRepresentationListener()
Returns:
the logicalRepresentationListener

getForm

public org.eclipse.ui.forms.widgets.ScrolledForm getForm()
Overrides:
getForm in class EditorEclipseForm
Returns:
the form

getSashForm

public org.eclipse.swt.custom.SashForm getSashForm()
Returns:
the sashForm

getAdapter

public java.lang.Object getAdapter(java.lang.Class adapter)
Specified by:
getAdapter in interface org.eclipse.core.runtime.IAdaptable
See Also:
WorkbenchPart.getAdapter(java.lang.Class)

isEditorInputModifiable

public boolean isEditorInputModifiable()
This needs to return true in order to enable the replace option of the the find dialog.

Specified by:
isEditorInputModifiable in interface org.eclipse.ui.texteditor.ITextEditorExtension2

validateEditorInputState

public boolean validateEditorInputState()
Specified by:
validateEditorInputState in interface org.eclipse.ui.texteditor.ITextEditorExtension2

TPTP 4.4.0 Testing Tools Project
Internal API Specification