org.safs.model.components

Class EditBox

java.lang.Object

org.safs.model.Component

org.safs.model.components.UIComponent

org.safs.model.components.GenericMaster

org.safs.model.components.GenericObject

org.safs.model.components.EditBox

public class EditBox
extends GenericObject

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EditBox(java.lang.String compname)
	EditBox(java.lang.String winname, java.lang.String compname) Constructor Create an instance of pseudo-component representing a specific component in a specific window.
	EditBox(Window window, java.lang.String compname) Constructor Create an instance of pseudo-component representing a specific component in a specific window.

Method Summary

Modifier and Type	Method and Description
void	setTextCharacters(StepTestTable table, java.lang.String textValue) Set the text of the editbox This action sets the text of the editbox.
ComponentFunction	setTextCharacters(java.lang.String textValue) Set the text of the editbox This action sets the text of the editbox.
void	setTextValue(StepTestTable table, java.lang.String textValue) Set the text of the editbox This action sets the text of the editbox.
ComponentFunction	setTextValue(java.lang.String textValue) Set the text of the editbox This action sets the text of the editbox.
void	setUnverifiedTextCharacters(StepTestTable table, java.lang.String textValue) Set the text of the editbox This action sets the text of the editbox.
ComponentFunction	setUnverifiedTextCharacters(java.lang.String textValue) Set the text of the editbox This action sets the text of the editbox.
void	setUnverifiedTextValue(StepTestTable table, java.lang.String textValue) Set the text of the editbox without verification This action sets the text of the editbox.
ComponentFunction	setUnverifiedTextValue(java.lang.String textValue) Set the text of the editbox without verification This action sets the text of the editbox.

Methods inherited from class org.safs.model.components.GenericObject

altLeftDrag, altLeftDrag, click, click, click, click, clickScreenImage, clickScreenImage, clickScreenLocation, clickScreenLocation, clickScreenPoint, clickScreenPoint, compareStoredData, compareStoredData, compareStoredData, compareStoredData, compareStoredProperties, compareStoredProperties, compareStoredProperties, compareStoredProperties, ctrlAltLeftDrag, ctrlAltLeftDrag, ctrlClick, ctrlClick, ctrlClick, ctrlClick, ctrlClickScreenImage, ctrlClickScreenImage, ctrlLeftDrag, ctrlLeftDrag, ctrlRightClick, ctrlRightClick, ctrlRightClick, ctrlRightClick, ctrlRightClickScreenImage, ctrlRightClickScreenImage, ctrlShiftLeftDrag, ctrlShiftLeftDrag, doubleClick, doubleClick, doubleClick, doubleClick, doubleClickScreenImage, doubleClickScreenImage, doubleClickScreenLocation, doubleClickScreenLocation, doubleClickScreenPoint, doubleClickScreenPoint, doubleTap, doubleTap, dragTo, dragTo, dragTo, dragTo, flick, flick, flick, flick, flickDown, flickDown, flickLeft, flickLeft, flickRight, flickRight, flickUp, flickUp, hScrollTo, hScrollTo, javaMenuSelect, javaMenuSelect, leftDrag, leftDrag, mouseClick, mouseClick, multiClick, multiClick, multiClick, multiClick, multiClickScreenImage, multiClickScreenImage, multiClickScreenImage, multiClickScreenImage, press, press, rightClick, rightClick, rightClick, rightClick, rightClickScreenImage, rightClickScreenImage, rightClickScreenLocation, rightClickScreenLocation, rightClickScreenPoint, rightClickScreenPoint, rightDrag, rightDrag, shiftClick, shiftClick, shiftClick, shiftClick, shiftClickScreenImage, shiftClickScreenImage, shiftLeftDrag, shiftLeftDrag, tap, tap, twoFingerTap, twoFingerTap, verifyImage, verifyImage, vScrollTo, vScrollTo

Methods inherited from class org.safs.model.components.GenericMaster

assignPropertyVariable, assignPropertyVariable, assignPropertyVariable, assignPropertyVariable, captureObjectDataToFile, captureObjectDataToFile, captureObjectDataToFile, captureObjectDataToFile, capturePropertiesToFile, capturePropertiesToFile, capturePropertiesToFile, capturePropertiesToFile, capturePropertyToFile, capturePropertyToFile, capturePropertyToFile, capturePropertyToFile, clearAppMapCache, clearAppMapCache, clearCache, clearCache, executeScript, executeScript, executeScript, executeScript, getComputedStyle, getComputedStyle, getGUIImage, getGUIImage, getGUIImage, getGUIImage, getTextFromGUI, getTextFromGUI, getTextFromGUI, getTextFromGUI, gUIDoesExist, gUIDoesExist, gUIDoesNotExist, gUIDoesNotExist, hoverMouse, hoverMouse, hoverMouse, hoverMouse, hoverScreenLocation, hoverScreenLocation, hoverScreenLocation, hoverScreenLocation, inputCharacters, inputCharacters, inputKeys, inputKeys, isPropertyExist, isPropertyExist, isPropertyExist, isPropertyExist, locateScreenImage, locateScreenImage, locateScreenImage, locateScreenImage, saveTextFromGUI, saveTextFromGUI, saveTextFromGUI, saveTextFromGUI, sendEvent, sendEvent, sendEvent, sendEvent, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, showOnPage, showOnPage, typeChars, typeChars, typeEncryption, typeEncryption, typeEncryption, typeEncryption, typeKeys, typeKeys, verifyArrayPropertyToFile, verifyArrayPropertyToFile, verifyArrayPropertyToFile, verifyArrayPropertyToFile, verifyBinaryFileToFile, verifyBinaryFileToFile, verifyBinaryFileToFile, verifyBinaryFileToFile, verifyClipboardToFile, verifyClipboardToFile, verifyClipboardToFile, verifyClipboardToFile, verifyClipboardVP, verifyClipboardVP, verifyComputedStyle, verifyComputedStyle, verifyFileToFile, verifyFileToFile, verifyFileToFile, verifyFileToFile, verifyGUIImageToFile, verifyGUIImageToFile, verifyGUIImageToFile, verifyGUIImageToFile, verifyObjectDataToFile, verifyObjectDataToFile, verifyObjectDataToFile, verifyObjectDataToFile, verifyPropertiesSubsetToFile, verifyPropertiesSubsetToFile, verifyPropertiesSubsetToFile, verifyPropertiesSubsetToFile, verifyPropertiesToFile, verifyPropertiesToFile, verifyPropertiesToFile, verifyPropertiesToFile, verifyProperty, verifyProperty, verifyProperty, verifyProperty, verifyPropertyContains, verifyPropertyContains, verifyPropertyContains, verifyPropertyContains, verifyPropertyToFile, verifyPropertyToFile, verifyPropertyToFile, verifyPropertyToFile, verifyTabOrder, verifyTabOrder, verifyTextFileToFile, verifyTextFileToFile, verifyTextFileToFile, verifyTextFileToFile, verifyValueContains, verifyValueContains, verifyValueContains, verifyValueContains, verifyValueContainsIgnoreCase, verifyValueContainsIgnoreCase, verifyValueContainsIgnoreCase, verifyValueContainsIgnoreCase, verifyValueDoesNotContain, verifyValueDoesNotContain, verifyValueDoesNotContain, verifyValueDoesNotContain, verifyValues, verifyValues, verifyValues, verifyValues, verifyValuesIgnoreCase, verifyValuesIgnoreCase, verifyValuesIgnoreCase, verifyValuesIgnoreCase, verifyValuesNotEqual, verifyValuesNotEqual, verifyValuesNotEqual, verifyValuesNotEqual

Methods inherited from class org.safs.model.components.UIComponent

getWindow, setWindow

Methods inherited from class org.safs.model.Component

getName, getParent, getParentName, quote

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EditBox

public EditBox(Window window,
               java.lang.String compname)

Constructor Create an instance of pseudo-component representing a specific component in a specific window.

Parameters:

window - Optional:NO Specifies which Window this component is 'in'.

compname - Optional:NO Specifies the AppMap name of the component in the Window.

EditBox

public EditBox(java.lang.String winname,
               java.lang.String compname)

Constructor Create an instance of pseudo-component representing a specific component in a specific window. This convenience routine will create the requisite Window component.

Parameters:

winname - Optional:NO Specifies the AppMap name of the window.

compname - Optional:NO Specifies the AppMap name of the component in the Window.

EditBox

protected EditBox(java.lang.String compname)

Method Detail

setTextCharacters

public ComponentFunction setTextCharacters(java.lang.String textValue)

 
            Set the text of the editbox
               
                This action sets the text of the editbox.
                It verifies we can read the property, sets the text value and then 
                verifies that the property has been set to that value.
                This routine uses only the literal text provided.  It does not attempt 
                to convert or interpret the text provided as special characters.  To 
                do that, see the SetTextValue command.
                  

Supporting Engines:

• Google Android
• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• Automated QA TestComplete
• OpenQA Selenium
• OpenQA Selenium

Parameters:

textValue - Optional:YES DefaultVal: The text that will be typed into the EditBox.

setTextCharacters

public void setTextCharacters(StepTestTable table,
                              java.lang.String textValue)

 
            Set the text of the editbox
               
                This action sets the text of the editbox.
                It verifies we can read the property, sets the text value and then 
                verifies that the property has been set to that value.
                This routine uses only the literal text provided.  It does not attempt 
                to convert or interpret the text provided as special characters.  To 
                do that, see the SetTextValue command.
                  

Supporting Engines:

• Google Android
• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• Automated QA TestComplete
• OpenQA Selenium
• OpenQA Selenium

Parameters:

table - Optional:NO The table to add the record to.

textValue - Optional:YES DefaultVal: The text that will be typed into the EditBox.

setTextValue

public ComponentFunction setTextValue(java.lang.String textValue)

 
                Set the text of the editbox
               
                This action sets the text of the editbox.  This version allows the use 
                of special character combinations and substrings to identify specific 
                keyboard keys.  These are the same special characters and interpretation 
                used for Robot's InputKeys command and the Windows Scripting Host.
                
                ~^+%{( are primarily the characters that induce special processing.
                
                The routine verifies we can read the text property, sets the text value 
                and will verify that the property has been set to that value *IF* none 
                of the special characters exist in the provided text value.  If those 
                special characters exist, then no post-set verification will occur.
                
                If you do not want to have any characters converted or interpretted as 
                special characters then you need to use the SetTextCharacters command.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• Automated QA TestComplete
• OpenQA Selenium
• OpenQA Selenium
• Google Android
• AUTOIT Team Autoit

Parameters:

textValue - Optional:YES DefaultVal: The text that will be typed into the EditBox and verified.

setTextValue

public void setTextValue(StepTestTable table,
                         java.lang.String textValue)

 
                Set the text of the editbox
               
                This action sets the text of the editbox.  This version allows the use 
                of special character combinations and substrings to identify specific 
                keyboard keys.  These are the same special characters and interpretation 
                used for Robot's InputKeys command and the Windows Scripting Host.
                
                ~^+%{( are primarily the characters that induce special processing.
                
                The routine verifies we can read the text property, sets the text value 
                and will verify that the property has been set to that value *IF* none 
                of the special characters exist in the provided text value.  If those 
                special characters exist, then no post-set verification will occur.
                
                If you do not want to have any characters converted or interpretted as 
                special characters then you need to use the SetTextCharacters command.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• Automated QA TestComplete
• OpenQA Selenium
• OpenQA Selenium
• Google Android
• AUTOIT Team Autoit

Parameters:

table - Optional:NO The table to add the record to.

textValue - Optional:YES DefaultVal: The text that will be typed into the EditBox and verified.

setUnverifiedTextCharacters

public ComponentFunction setUnverifiedTextCharacters(java.lang.String textValue)

 
            Set the text of the editbox
               
                This action sets the text of the editbox.
                This routine uses only the literal text provided.  It does not attempt 
                to convert or interpret the text provided as special characters.  To 
                do that, see the SetTextValue commands.
                No attempt to verify the EditBox value is performed.
                  

Supporting Engines:

• Google Android
• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• Automated QA TestComplete
• OpenQA Selenium
• OpenQA Selenium

Parameters:

textValue - Optional:YES DefaultVal: The text that will be typed into the EditBox.

setUnverifiedTextCharacters

public void setUnverifiedTextCharacters(StepTestTable table,
                                        java.lang.String textValue)

 
            Set the text of the editbox
               
                This action sets the text of the editbox.
                This routine uses only the literal text provided.  It does not attempt 
                to convert or interpret the text provided as special characters.  To 
                do that, see the SetTextValue commands.
                No attempt to verify the EditBox value is performed.
                  

Supporting Engines:

• Google Android
• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• Automated QA TestComplete
• OpenQA Selenium
• OpenQA Selenium

Parameters:

table - Optional:NO The table to add the record to.

textValue - Optional:YES DefaultVal: The text that will be typed into the EditBox.

setUnverifiedTextValue

public ComponentFunction setUnverifiedTextValue(java.lang.String textValue)

 
                Set the text of the editbox without verification
               
                This action sets the text of the editbox.  This version allows the use 
                of special character combinations and substrings to identify specific 
                keyboard keys.  These are the same special characters and interpretation 
                used for Robot's InputKeys command and the Windows Scripting Host.
                
                The routine does not verify that the property has been set to that 
                value.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• Automated QA TestComplete
• OpenQA Selenium
• OpenQA Selenium
• Google Android

Parameters:

textValue - Optional:YES DefaultVal: The text that will be typed into the EditBox.

setUnverifiedTextValue

public void setUnverifiedTextValue(StepTestTable table,
                                   java.lang.String textValue)

 
                Set the text of the editbox without verification
               
                This action sets the text of the editbox.  This version allows the use 
                of special character combinations and substrings to identify specific 
                keyboard keys.  These are the same special characters and interpretation 
                used for Robot's InputKeys command and the Windows Scripting Host.
                
                The routine does not verify that the property has been set to that 
                value.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• Automated QA TestComplete
• OpenQA Selenium
• OpenQA Selenium
• Google Android

Parameters:

table - Optional:NO The table to add the record to.

textValue - Optional:YES DefaultVal: The text that will be typed into the EditBox.