public class ChoiceProxy extends ComponentProxy implements IComboBox
SelectGuiSubitemTestObject
Type | Desciption | Data Class |
---|---|---|
list | Combo List Elements | ITestDataList |
selected | Selected List Element | ITestDataList |
Property | Usage |
---|---|
.class | The Java full class name of the test object. |
.classIndex | The zero-based index of the class relative to the immediate parent in the object map. |
.itemText | The text for the up to ten items from the list. |
.priorLabel | The text of a preceding label. Suppressed if there is no preceding label. |
itemCount | The number of items in the list. |
name | The name property, suppressed if default formatted (default form = className+count). |
Subitem | Usage | |
---|---|---|
Text |
Defines the element with the specified visible text. | |
Index |
Defines the element at the specified zero-based index. |
ComponentProxy.ChildEnumerator, ComponentProxy.ImmediateChildEnumerator
childrenEnumerated, CLASSINDEX, CLASSINDEXWEIGHT, MAX_NAME, NAMEPROPERTY, NAMEPROPERTYWEIGHT, PRIORLABEL, PRIORLABELWEIGHT
LEFT, preDownState, processMouseEventHandler, ROLEINDEX, ROLEINDEXWEIGHT, TESTDATA_SPECIALFRAMESTATE, TESTDATA_SPECIALFRAMESTATE_DESCRIPTION, topLevelWindow
BROWSERTABTESTOBJECT_CLASSNAME, BROWSERTESTOBJECT_CLASSNAME, COLORDIALOGTESTOBJECT_CLASSNAME, CROSSDOMAINCONTAINER_CLASSNAME, DOCUMENTTESTOBJECT_CLASSNAME, DOMAINTESTOBJECT_CLASSNAME, ECLIPSETOPLEVELTESTOBJECT_CLASSNAME, EMBEDDEDBROWSERTESTOBJECT_CLASSNAME, FILEDIALOGTESTOBJECT_CLASSNAME, FRAMESUBITEMTESTOBJECT_CLASSNAME, FRAMETESTOBJECT_CLASSNAME, GEFEDITPARTTESTOBJECT_CLASSNAME, GUISUBITEMTESTOBJECT_CLASSNAME, GUITESTOBJECT_CLASSNAME, INTERNALFRAMETESTOBJECT_CLASSNAME, MESSAGEBOXTESTOBJECT_CLASSNAME, PALETTEGUISUBITEMTESTOBJECT_CLASSNAME, PROCESSTESTOBJECT_CLASSNAME, SCROLLSUBITEMTESTOBJECT_CLASSNAME, SCROLLTESTOBJECT_CLASSNAME, SELECTGUISUBITEMTESTOBJECT_CLASSNAME, SELECTSCROLLGUISUBITEMTESTOBJECT_CLASSNAME, SHELLTESTOBJECT_CLASSNAME, STATELESSGUISUBITEMTESTOBJECT_CLASSNAME, SUBITEMTESTOBJECT_CLASSNAME, TABITEMTESTOBJECT_CLASSNAME, TESTOBJECT_CLASSNAME, TEXTGUISUBITEMTESTOBJECT_CLASSNAME, TEXTGUITESTOBJECT_CLASSNAME, TEXTSCROLLTESTOBJECT_CLASSNAME, TEXTSELECTGUISUBITEMTESTOBJECT_CLASSNAME, TIMEOUTTESTOBJECT_CLASSNAME, TOGGLEGUITESTOBJECT_CLASSNAME, TOGGLETESTOBJECT_CLASSNAME, TOPLEVELSUBITEMTESTOBJECT_CLASSNAME, TOPLEVELTESTOBJECT_CLASSNAME, TRACKBARTESTOBJECT_CLASSNAME, vomClippedRectangle
INCLUDE_ALL, INCLUDE_JUSTOBJECT, INCLUDE_SIBLINGS
Constructor and Description |
---|
ChoiceProxy(java.lang.Object theObjectInTheSUT)
This sole constructor for all proxy objects sets the SUT object
as a member variable for the proxy.
|
Modifier and Type | Method and Description |
---|---|
void |
click()
Left mouse click on the center point of the associated TestObject;
is a simple shortcut to the click method with a modifier
parameter (modifier set to MOUSE_LEFT).
|
void |
click(MouseModifiers modifiers,
Subitem subitem)
Perform a mouse click action at the specified object relative
coordinates within the associated TestObject.
|
void |
click(MouseModifiers modifiers,
Subitem subitem,
java.awt.Point pt)
Perform a mouse click action on the specified coordinates relative
to the associated TestObject.
|
void |
click(Subitem subitem)
Left mouse click on the center point of the associated subitem.
|
void |
click(Subitem subitem,
java.awt.Point pt)
Left mouse click on the specified coordinates relative to the
associated TestObject.
|
void |
doubleClick(MouseModifiers modifiers,
Subitem subitem)
Perform a mouse dbl-click action at the specified object relative
coordinates within the associated TestObject.
|
void |
doubleClick(MouseModifiers modifiers,
Subitem subitem,
java.awt.Point pt)
Perform a mouse dbl-click action on the specified coordinates relative
to the associated TestObject.
|
void |
doubleClick(Subitem subitem)
Left mouse dbl-click on the center point of the associated TestObject.
|
void |
doubleClick(Subitem subitem,
java.awt.Point pt)
Left mouse dbl-click on the specified coordinates relative to the
associated TestObject.
|
void |
drag()
Perform a MOUSE_LEFT drag action against the associated TestObject.
|
void |
drag(MouseModifiers modifiers,
Subitem subitem)
Perform a drag action against the associated TestObject with the
supplied set of mouse modifiers.
|
void |
drag(MouseModifiers modifiers,
Subitem subitem1,
java.awt.Point pt1,
Subitem subitem2,
java.awt.Point pt2)
Perform a drag action against the associated TestObject.
|
void |
drag(MouseModifiers modifiers,
Subitem subitem1,
Subitem subitem2)
Perform a drag action against the associated TestObject.
|
void |
drag(Subitem subitem)
Perform a MOUSE_LEFT drag action against the associated TestObject.
|
void |
drag(Subitem subitem1,
java.awt.Point pt1,
Subitem subitem2,
java.awt.Point pt2)
Perform a MOUSE_LEFT drag action against the associated TestObject.
|
void |
drag(Subitem subitem1,
Subitem subitem2)
Perform a MOUSE_LEFT drag action against the associated TestObject.
|
void |
dragToScreenPoint(MouseModifiers modifiers,
Subitem subitem,
java.awt.Point screenPt)
Perform a drag action against the associated TestObject.
|
void |
dragToScreenPoint(MouseModifiers modifiers,
Subitem subitem,
java.awt.Point subitemPt,
java.awt.Point screenPt)
Perform a drag action against the associated TestObject.
|
void |
dragToScreenPoint(Subitem subitem,
java.awt.Point screenPt)
Perform a MOUSE_LEFT drag action against the associated TestObject.
|
void |
dragToScreenPoint(Subitem subitem,
java.awt.Point subitemPt,
java.awt.Point screenPt)
Perform a MOUSE_LEFT drag action against the associated TestObject.
|
java.util.Enumeration |
getChildrenEnumeration()
Return an enumeration of proxies for the children
of this object.
|
protected java.awt.Rectangle |
getClickActionRect()
Gets the screen relative rectangle and throws an invalid action
exception if the rectangle is not valid.
|
MethodSpecification |
getDataDrivableCommand()
This method must be implemented by any proxy that wishes to support
data driving.
|
int |
getItemCount()
This method returns the number of items available in the associated ComboBox
control.
|
protected java.lang.String[] |
getItems(int limit) |
java.lang.String |
getItemText(int itemIndex)
This method returns the text of the item at the specified index.
|
java.lang.Object |
getProperty(java.lang.String propertyName)
Get the value for a specific property.
|
java.lang.String |
getRole()
Returns
TestObjectRole.ROLE_COMBO_BOX . |
java.awt.Point |
getScreenPoint(Subitem subitem)
Returns the screen relative point to the center of the supplied
subitem.
|
java.awt.Point |
getScreenPoint(Subitem subitem,
java.awt.Point pt)
Returns the screen relative point given a subitem and a subitem
relative point.
|
java.awt.Rectangle |
getScreenRectangle(Subitem subitem)
Returns the rectangle that contains the component being
evaluated relative to the top left corner of the screen.
|
int |
getSelectedIndex()
This method returns the index of the selected item in the associated ComboBox
control.
|
java.lang.String |
getSelectedText() |
java.lang.Object |
getSubitem(Subitem subitem)
Returns an object that represents the specified subitem in the associated
test object.
|
ITestData |
getTestData(java.lang.String testDataType)
This method constructs the specified verification data object.
|
java.util.Hashtable |
getTestDataTypes()
Returns a hashtable of data type descriptions of the verification
point data available with the associated object in the SUT.
|
java.lang.String |
getTestObjectClassName()
Return the test object that implements IGraphicalSubitem.
|
java.lang.String |
getText() |
void |
hover(double secondDelay,
Subitem subitem)
Hover the mouse over the center of the specified subitem.
|
void |
hover(double secondDelay,
Subitem subitem,
java.awt.Point pt)
Hover the mouse over the specified coordinates relative to the
specified subitem.
|
void |
hover(Subitem subitem)
Hovers the mouse over the specified
specified subitem.
|
void |
hover(Subitem subitem,
java.awt.Point pt)
Hovers the mouse over the specified coordinates relative to the
specified subitem.
|
protected boolean |
isEditable()
Returns true if this Choice is editable.
|
void |
mouseMove(MouseModifiers modifiers,
Subitem subitem)
Perform a move action against the associated TestObject.
|
void |
mouseMove(MouseModifiers modifiers,
Subitem subitem,
java.awt.Point pt)
Perform a move action against the associated TestObject.
|
void |
mouseMove(Subitem subitem)
Perform a MOUSE_LEFT move action against the associated TestObject.
|
void |
mouseMove(Subitem subitem,
java.awt.Point subitemPt)
Perform a MOUSE_LEFT move action against the associated TestObject.
|
void |
nClick(int clickCount,
MouseModifiers modifiers,
Subitem subitem,
java.awt.Point pt)
Perform a mouse n-click action on the specified coordinates relative
to the associated TestObject.
|
void |
nClickDrag(int clickCount,
MouseModifiers modifiers,
Subitem subitem1,
java.awt.Point pt1,
Subitem subitem2,
java.awt.Point pt2)
Perform a mouse n-click drag action on the specified coordinates relative
to the associated TestObject.
|
void |
nClickDrag(int clickCount,
MouseModifiers modifiers,
Subitem subitem1,
Subitem subitem2)
Perform a mouse n-click drag action on the specified coordinates relative
to the associated TestObject.
|
void |
nClickDragToScreenPoint(int clickCount,
MouseModifiers modifiers,
Subitem subitem,
java.awt.Point screenPt)
Perform a mouse n-click drag action on the specified coordinates relative
the screen relative screenPt coordinates.
|
void |
nClickDragToScreenPoint(int clickCount,
MouseModifiers modifiers,
Subitem subitem,
java.awt.Point subitemPt,
java.awt.Point screenPt)
Perform a mouse n-click drag action on the specified coordinates relative
the screen relative screenPt coordinates.
|
boolean |
needMethodSpecForPoint()
Returns
true if getMethodSpecForPoint should return a coordinate based
action for drags onto the popup. |
void |
processSingleMouseEvent(IMouseActionInfo action)
Return a MethodSpecification for the specified mouse event.
|
void |
select(int index) |
void |
select(java.lang.String item) |
void |
setState(com.rational.test.ft.script.Action action)
This method performs a specific action.
|
void |
setState(com.rational.test.ft.script.Action action,
Subitem item)
This method performs a specific action against the subitem
at a specified index.
|
void |
setState(com.rational.test.ft.script.Action action,
Subitem start,
Subitem end)
This method performs a specific action against the subitem
range defined by the specified indices.
|
ITestData |
updateTestData(java.lang.String testDataType,
ITestData testData)
This method updates the supplied test data object and returns it.
|
protected java.awt.Rectangle |
waitForScreenRectangle(int subitemIndex) |
canBeScrolled, childConstructed, getChildAtPoint, getChildProxy, getClippedRect, getComponentChildren, getDescriptiveName, getElementWithFocus, getEmbeddedBrowsers, getImmediateChildren, getLabelText, getLeadingLabel, getLocationOnScreen, getMappableChildren, getMappableParent, getName, getOwnedObjects, getOwner, getParent, getParent2, getParentObject, getScreenRectangle, getTopParent, getWindow, hasFocus, isDopeyDynamicName, isEnabled, isHScroll, isLabelled, isOpaque, isRecognitionProperty, isShowing, isVScroll, setParent
activateTopWindow, doubleClick, dragToScreenPoint, dumpAction, ensureObjectIsVisible, getActionRect, getCachedRectX, getCachedRectY, getClippedScreenRectangle, getMethodSpecForPoint, getProcessMouseEventHandler, getRegisteredTopLevelWindow, getScreenPoint, getScriptCommandFlags, getTopMappableWindow, getTopWindow, hover, invokeMethodOnEDT, isDrag, isPointInObject, isPointInObject, modifiersChanged, nClick, processHoverMouseEvent, processMouseEvent, scrollRectToVisible, setProcessMouseEventHandler, setTopLevelWindow, shouldBeMapped
addMappableChildrenToVector, addRecognitionProperty, allowProperty, getAddedRecognitionPropertyValue, getChildren, getIndexer, getIndexers, getMethods, getNonValueProperties, getProperties, getRecognitionProperties, getRecognitionPropertyWeight, getStandardProperties, getTestDomain, getTopMappableParent, getUniqueId, getVisualClippableParent, hasAddedRecognitionProperties, setIndexer, setProperty
addDataDrivableCommands, baseClassMatch, canTakeVP, equals, findChildrenWithProperties, findChildrenWithPropertiesAndInvoke, getChannel, getChildren, getDataDrivableCommands, getField, getIgnorableProperties, getMappableChildren, getMappableParent, getObjectClassName, getObjectCustomClassName, getOwnedObjects, getParent, getProxy, getScriptCommandAnchor, getVisualClippedRectangle, getVisualMappableChildren, getVisualTopParent, getVOMSpecificProperty, hasSpecialFrameState, isClassIndexConsidered, isSameObject, isValidObject, ping, suppressKeyAction
public ChoiceProxy(java.lang.Object theObjectInTheSUT)
public java.lang.String getTestObjectClassName()
getTestObjectClassName
in interface IProxyBase
getTestObjectClassName
in class JavaGuiProxy
public java.lang.String getRole()
TestObjectRole.ROLE_COMBO_BOX
.getRole
in class ComponentProxy
public java.util.Enumeration getChildrenEnumeration()
getChildrenEnumeration
in class ComponentProxy
protected boolean isEditable()
public int getSelectedIndex()
getSelectedIndex
in interface IComboBox
public int getItemCount()
getItemCount
in interface IComboBox
public java.lang.String getItemText(int itemIndex)
getItemText
in interface IComboBox
itemIndex
- The zero-based index of the desired item.protected java.lang.String[] getItems(int limit)
public boolean needMethodSpecForPoint()
true
if getMethodSpecForPoint should return a coordinate based
action for drags onto the popup.needMethodSpecForPoint
in interface IComboBox
public java.lang.Object getProperty(java.lang.String propertyName)
getProperty
in class ComponentProxy
propertyName
- The name of the property to fetch.ProxyTestObject.getProperties()
,
ProxyTestObject.setProperty(String,Object)
,
ProxyTestObject.getRecognitionProperties()
,
ProxyTestObject.addRecognitionProperty(String,Object,int)
public MethodSpecification getDataDrivableCommand()
null
value is returned.getDataDrivableCommand
in interface IDataDriven
getDataDrivableCommand
in class ProxyTestObject
ProxyTestObject.getDataDrivableCommands(int)
public void processSingleMouseEvent(IMouseActionInfo action)
processSingleMouseEvent
in class JavaGuiProxy
action
- The event cache and other mouse state information
for this mouse action.public java.awt.Rectangle getScreenRectangle(Subitem subitem)
protected java.awt.Rectangle waitForScreenRectangle(int subitemIndex)
public java.awt.Point getScreenPoint(Subitem subitem)
getScreenPoint
in class JavaGuiProxy
subitem
- The subitem the resultant screen point is
relative to.public java.awt.Point getScreenPoint(Subitem subitem, java.awt.Point pt)
subitem
- The subitem the resultant screen point is
relative to.pt
- The subitem relative point.public java.lang.Object getSubitem(Subitem subitem)
SubitemNotFoundException
will be thrown if the specified subitem is invalid relative to the associated
test object. null
may be returned if the subitem does not have
an object association that can be returned.
Note that if the resulting type is not a value class that a test object for the
object will be supplied. For instance MyMenuBar().getSubitem(atPath("File->New"))
would return the TestObject
for the New menu
item (with all the associated methods available). A simpler example may be that
myList().getSubitem(atIndex(4))
will commonly just return the text
for the item in the 5th position (as a string).
WARNING: if the result of this call is a TestObject
then the user is
required to explicitly unregister
the resulting
test object. Failure to do so will cause objects to be pinned in the memory
of the system under test.
subitem
- The subitem to fetch an object for.public java.lang.String getSelectedText()
public java.lang.String getText()
public void select(java.lang.String item)
public void select(int index)
protected java.awt.Rectangle getClickActionRect()
public void click()
JavaGuiProxy
click
in class JavaGuiProxy
public void drag()
JavaGuiProxy
drag
in class JavaGuiProxy
public void click(Subitem subitem)
click
in class JavaGuiProxy
public void click(MouseModifiers modifiers, Subitem subitem)
click
in class JavaGuiProxy
public void click(Subitem subitem, java.awt.Point pt)
click
in class JavaGuiProxy
public void click(MouseModifiers modifiers, Subitem subitem, java.awt.Point pt)
public void doubleClick(Subitem subitem)
doubleClick
in class JavaGuiProxy
public void doubleClick(MouseModifiers modifiers, Subitem subitem)
doubleClick
in class JavaGuiProxy
public void doubleClick(Subitem subitem, java.awt.Point pt)
doubleClick
in class JavaGuiProxy
public void doubleClick(MouseModifiers modifiers, Subitem subitem, java.awt.Point pt)
public void nClick(int clickCount, MouseModifiers modifiers, Subitem subitem, java.awt.Point pt)
public void drag(Subitem subitem)
drag
in class JavaGuiProxy
public void drag(MouseModifiers modifiers, Subitem subitem)
drag
in class JavaGuiProxy
public void drag(Subitem subitem1, Subitem subitem2)
drag
in class JavaGuiProxy
public void drag(MouseModifiers modifiers, Subitem subitem1, Subitem subitem2)
drag
in class JavaGuiProxy
public void drag(Subitem subitem1, java.awt.Point pt1, Subitem subitem2, java.awt.Point pt2)
public void drag(MouseModifiers modifiers, Subitem subitem1, java.awt.Point pt1, Subitem subitem2, java.awt.Point pt2)
public void nClickDrag(int clickCount, MouseModifiers modifiers, Subitem subitem1, Subitem subitem2)
nClickDrag
in class JavaGuiProxy
public void nClickDrag(int clickCount, MouseModifiers modifiers, Subitem subitem1, java.awt.Point pt1, Subitem subitem2, java.awt.Point pt2)
public void dragToScreenPoint(Subitem subitem, java.awt.Point screenPt)
dragToScreenPoint
in class JavaGuiProxy
public void dragToScreenPoint(MouseModifiers modifiers, Subitem subitem, java.awt.Point screenPt)
dragToScreenPoint
in class JavaGuiProxy
public void dragToScreenPoint(Subitem subitem, java.awt.Point subitemPt, java.awt.Point screenPt)
dragToScreenPoint
in class JavaGuiProxy
public void dragToScreenPoint(MouseModifiers modifiers, Subitem subitem, java.awt.Point subitemPt, java.awt.Point screenPt)
public void nClickDragToScreenPoint(int clickCount, MouseModifiers modifiers, Subitem subitem, java.awt.Point screenPt)
nClickDragToScreenPoint
in class JavaGuiProxy
public void nClickDragToScreenPoint(int clickCount, MouseModifiers modifiers, Subitem subitem, java.awt.Point subitemPt, java.awt.Point screenPt)
public void mouseMove(Subitem subitem)
mouseMove
in class JavaGuiProxy
public void mouseMove(Subitem subitem, java.awt.Point subitemPt)
mouseMove
in class JavaGuiProxy
public void mouseMove(MouseModifiers modifiers, Subitem subitem)
mouseMove
in class JavaGuiProxy
public void mouseMove(MouseModifiers modifiers, Subitem subitem, java.awt.Point pt)
public void hover(double secondDelay, Subitem subitem)
hover
in class JavaGuiProxy
public void hover(double secondDelay, Subitem subitem, java.awt.Point pt)
public void hover(Subitem subitem)
hover
in class JavaGuiProxy
public void hover(Subitem subitem, java.awt.Point pt)
hover
in class JavaGuiProxy
public void setState(com.rational.test.ft.script.Action action, Subitem item)
item
- The item to act upon.action
- The action that should be performed.public void setState(com.rational.test.ft.script.Action action)
action
- The action that should be performed.public void setState(com.rational.test.ft.script.Action action, Subitem start, Subitem end)
start
- The first item to act upon.end
- The last item to act upon.action
- The action that should be performed.public java.util.Hashtable getTestDataTypes()
getTestDataTypes
in class JavaProxy
getTestData(String)
,
ITestData
public ITestData getTestData(java.lang.String testDataType)
getTestDataTypes
.getTestData
in class ProxyTestObject
testDataType
- A test data type supplied by
getTestDataTypes
.getTestDataTypes()
,
ITestData
public ITestData updateTestData(java.lang.String testDataType, ITestData testData)
getTestDataTypes
.
The testData is a previously supplied ITestData
object that needs to be updated to reflect the current state
of the associated test object.updateTestData
in class ProxyTestObject
testDataType
- A test data type supplied by
getTestDataTypes
.testData
- The test data base object that requires
updating.getTestDataTypes()
,
ITestData