IBM Rational Functional Tester
Version 6.1
IBM Rational Functional Tester API Reference

Project Version 2.0

com.rational.test.ft.object.interfaces
Class ToggleGUITestObject

java.lang.Object
  extended bycom.rational.test.ft.object.interfaces.TestObject
      extended bycom.rational.test.ft.object.interfaces.GuiTestObject
          extended bycom.rational.test.ft.object.interfaces.ToggleTestObject
              extended bycom.rational.test.ft.object.interfaces.ToggleGUITestObject
All Implemented Interfaces:
IGraphical, IToggle, IToggleGUI

public class ToggleGUITestObject
extends ToggleTestObject
implements IToggleGUI

Extends the definition of the IToggle interface to include actions that directly use the mouse.

Since:
RFT1.0

Constructor Summary
ToggleGUITestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject)
          For internal use.
ToggleGUITestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor)
          For internal use.
ToggleGUITestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor, long scriptCommandFlags)
          For internal use.
ToggleGUITestObject(TestObject obj)
          Constructs one ToggleGUITestObject from another TestObject.
ToggleGUITestObject(com.rational.test.ft.object.TestObjectReference ref)
          For internal use.
 
Method Summary
 void clickToState(MouseModifiers modifiers, State state)
          Performs the necessary mouse actions to attain the desired state for the associated component.
 void clickToState(State state)
          Performs the necessary mouse actions to attain the desired state for the associated component.
 void dragToState(MouseModifiers modifiers, State state)
          Performs the necessary mouse actions to attain the desired state for the associated component.
 void dragToState(State state)
          Performs the necessary mouse actions to attain the desired state for the associated component.
 
Methods inherited from class com.rational.test.ft.object.interfaces.ToggleTestObject
deselect, getState, indeterminate, select, setState
 
Methods inherited from class com.rational.test.ft.object.interfaces.GuiTestObject
click, click, click, click, clickRadio, doubleClick, doubleClick, doubleClick, doubleClick, drag, drag, drag, drag, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, getChildAtPoint, getClippedScreenRectangle, getScreenPoint, getScreenPoint, getScreenRectangle, getScreenSnapshot, hasFocus, hover, hover, hover, hover, invokeProxyWithGuiDelay, invokeProxyWithGuiDelay, isEnabled, isOpaque, isPointInObject, isShowing, mouseMove, mouseMove, nClick, nClickDrag, nClickDragToScreenPoint
 
Methods inherited from class com.rational.test.ft.object.interfaces.TestObject
equals, exists, find, find, find, findAndInvoke, findAndInvoke, findAndInvokeProxy, getChildren, getDescribedObject, getDescribedObjects, getDomain, getField, getIndexer, getIndexer, getIndexers, getMappableChildren, getMappableParent, getMethods, getNameInScript, getNonValueProperties, getObjectClassName, getObjectReference, getOwnedObjects, getOwner, getParent, getProcess, getProperties, getProperty, getPropertyFromMap, getRecognitionProperties, getRecognitionPropertyWeight, getScriptCommandFlags, getStandardProperties, getTestData, getTestDataTypes, getTopMappableParent, getTopParent, invoke, invoke, invokeProxy, invokeProxy, isMappedObject, isSameObject, setIndexer, setIndexer, setProperty, toString, unregister, updateTestData, waitForExistence, waitForExistence
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.rational.test.ft.object.interfaces.IToggle
deselect, getState, indeterminate, select, setState
 

Constructor Detail

ToggleGUITestObject

public ToggleGUITestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject)
For internal use.

Since:
RFT1.0

ToggleGUITestObject

public ToggleGUITestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject,
                           TestObject anchor)
For internal use.

Since:
RFT1.0

ToggleGUITestObject

public ToggleGUITestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject,
                           TestObject anchor,
                           long scriptCommandFlags)
For internal use.

Since:
RFT1.0

ToggleGUITestObject

public ToggleGUITestObject(com.rational.test.ft.object.TestObjectReference ref)
For internal use.

Since:
RFT1.0

ToggleGUITestObject

public ToggleGUITestObject(TestObject obj)
Constructs one ToggleGUITestObject from another TestObject. Both are references to the same object.

Since:
RFT1.0
Method Detail

clickToState

public void clickToState(State state)
Performs the necessary mouse actions to attain the desired state for the associated component. If the component is already in the desired state, multiple actions may be performed to trigger underlying programmatic events to ensure that the state is reset appropriately.

Specified by:
clickToState in interface IToggleGUI
Parameters:
state - the desired target state for the associated component
Since:
RFT1.0

clickToState

public void clickToState(MouseModifiers modifiers,
                         State state)
Performs the necessary mouse actions to attain the desired state for the associated component. If the component is already in the desired state, multiple actions may be performed to trigger underlying programmatic events to ensure that the state is reset appropriately.

Specified by:
clickToState in interface IToggleGUI
Parameters:
modifiers - the mouse modifiers for attaining the desired state
state - the target state for the associated component
Since:
RFT1.0

dragToState

public void dragToState(State state)
Performs the necessary mouse actions to attain the desired state for the associated component. If the component is already in the desired state, multiple actions may be performed to trigger underlying programmatic events to ensure that the state is reset appropriately.

Specified by:
dragToState in interface IToggleGUI
Parameters:
state - the target state for the associated component
Since:
RFT1.0

dragToState

public void dragToState(MouseModifiers modifiers,
                        State state)
Performs the necessary mouse actions to attain the desired state for the associated component. If the component is already in the desired state, multiple actions may be performed to trigger underlying programmatic events to ensure that the state is reset appropriately.

Specified by:
dragToState in interface IToggleGUI
Parameters:
modifiers - the mouse modifiers to be used to attain the desired state
state - the target state for the associated component
Since:
RFT1.0