IBM Rational Functional Tester
Version 8.1.1000
IBM Rational Functional Tester API Reference

Project Version 2.3

com.rational.test.ft.object.interfaces.siebel
Class SiebTreeTestObject

java.lang.Object   extended by com.rational.test.ft.object.interfaces.TestObject
      extended by com.rational.test.ft.object.interfaces.ClientTestObject
          extended by com.rational.test.ft.object.interfaces.GuiTestObject
              extended by com.rational.test.ft.object.interfaces.siebel.SiebTestObject
                  extended by com.rational.test.ft.object.interfaces.siebel.SiebTreeTestObject
All Implemented Interfaces:
IGraphical, ISiebTestObject

public class SiebTreeTestObject
extends SiebTestObject

Provides script access to the SiebTree.TestObject class.

Since:
RFT2.1

Field Summary
static java.lang.String CLASSNAME
           
 
Fields inherited from class com.rational.test.ft.object.interfaces.TestObject
ref
 
Constructor Summary
SiebTreeTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject)
          For internal use.
SiebTreeTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor)
          For internal use.
SiebTreeTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor, long scriptCommandFlags)
          For internal use.
SiebTreeTestObject(TestObject obj)
          Constructs one TestObject from another.
SiebTreeTestObject(com.rational.test.ft.object.TestObjectReference ref)
          For internal use.
 
Method Summary
 void collapse(Subitem pathOrIndex)
          Collapses a node in the tree view.
 void expand(Subitem pathOrIndex)
          Expands a node in the tree view.
 int getChildCount(Subitem pathOrIndex)
          Finds the tree item and returns the number of child nodes of the tree item that are displayed on the current page.
 java.lang.String getTreeItemName(Subitem pathOrIndex)
          Finds the tree item and returns the visible text of the specified tree item.
 boolean isExists(Subitem pathOrIndex)
          Returns a Boolean value indicating whether the specified object exists (TRUE) or does not exist (FALSE).
 boolean isExpanded(Subitem pathOrIndex)
          Returns a Boolean value indicating whether the specified tree node is expanded (TRUE) or collapsed (FALSE).
 boolean isSelected(Subitem pathOrIndex)
          Returns a Boolean value indicating whether the specified tree node is selected (TRUE) or not selected (FALSE).
 void nextPage()
          Scrolls the tree view to the next page.
 void previousPage()
          Scrolls the tree view to the previous page.
 void select(java.lang.String position)
          Selects a node in the tree view.
 void select(Subitem pathOrIndex)
          Selects a node in the tree view.
 
Methods inherited from class com.rational.test.ft.object.interfaces.siebel.SiebTestObject
atChild, atChild, atDescendant, atDescendant, getChildOfName, getChildOfName, getChildOfNameAndType, getChildOfNameAndType, getChildOfUIName, getChildOfUIName, getChildOfUINameAndType, getChildOfUINameAndType, getChildren, getChildren, getChildrenOfType, getChildrenOfType, getDescendantsOfName, getDescendantsOfName, getDescendantsOfNameAndType, getDescendantsOfNameAndType, getDescendantsOfType, getDescendantsOfType, getDescendantsOfUIName, getDescendantsOfUIName, getDescendantsOfUINameAndType, getDescendantsOfUINameAndType, submit, submit, submit, submit, submit, submit
 
Methods inherited from class com.rational.test.ft.object.interfaces.GuiTestObject
canTakeVP, click, click, click, click, clickRadio, doubleClick, doubleClick, doubleClick, doubleClick, drag, drag, drag, drag, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, ensureObjectIsVisible, getChildAtPoint, getClippedScreenRectangle, getImage, getImage, getScreenPoint, getScreenPoint, getScreenRectangle, getScreenSnapshot, getVisibleArea, 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.ClientTestObject
exists, find, find, findAndInvoke, findAndInvokeProxy, invoke, invokeProxy, unregister, waitForExistence
 
Methods inherited from class com.rational.test.ft.object.interfaces.TestObject
compare, compare, compareAndLog, compareAndLog, equals, find, findAndInvoke, getActualData, getDescribedObject, getDescribedObjects, getDescriptiveName, getDomain, getField, getIndexer, getIndexer, getIndexers, getMappableChildren, getMappableParent, getMapProperties, getMethods, getNameInScript, getNonValueProperties, getObjectClassName, getObjectCustomClassName, getObjectReference, getOwnedObjects, getOwner, getParent, getProcess, getProperties, getProperty, getPropertyFromMap, getRecognitionProperties, getRecognitionPropertyWeight, getScriptCommandFlags, getStandardProperties, getTestData, getTestDataTypes, getTopMappableParent, getTopParent, hashCode, invoke, invokeProxy, isMappedObject, isSameObject, isScreenTestObject, isTopLevelTestObject, performTest, performTest, performTest, performTest, setIndexer, setIndexer, setMapProperties, setProperty, toString, updateTestData, waitForExistence
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASSNAME

public static final java.lang.String CLASSNAME
See Also:
Constant Field Values
Constructor Detail

SiebTreeTestObject

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

Since:
RFT2.1

SiebTreeTestObject

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

Since:
RFT2.1

SiebTreeTestObject

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

Since:
RFT2.1

SiebTreeTestObject

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

Since:
RFT2.1

SiebTreeTestObject

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

Since:
RFT2.1
Method Detail

getChildCount

public int getChildCount(Subitem pathOrIndex)
Finds the tree item and returns the number of child nodes of the tree item that are displayed on the current page.

Parameters:
pathOrIndex - a Subitem (either atPath() or atList()) that indicates the position of the node in the tree
Returns:
The number of child nodes of the tree item that are displayed on the current page
Since:
RFT2.1

getTreeItemName

public java.lang.String getTreeItemName(Subitem pathOrIndex)
Finds the tree item and returns the visible text of the specified tree item.

Parameters:
pathOrIndex - a Subitem (either atPath() or atList()) that indicates the position of the node in the tree
Returns:
The visible text of the specified tree item
Since:
RFT2.1

nextPage

public void nextPage()
Scrolls the tree view to the next page.

Since:
RFT2.1

previousPage

public void previousPage()
Scrolls the tree view to the previous page.

Since:
RFT2.1

expand

public void expand(Subitem pathOrIndex)
Expands a node in the tree view.

Parameters:
pathOrIndex - A Subitem (either atPath() or atList()) that indicates the position of the node in the tree
Since:
RFT2.1

collapse

public void collapse(Subitem pathOrIndex)
Collapses a node in the tree view.

Parameters:
pathOrIndex - a Subitem (either atPath() or atList()) that indicates the position of the node in the tree
Since:
RFT2.1

select

public void select(java.lang.String position)
Selects a node in the tree view.

Parameters:
position - the position of the node (in the CAS supported format) in the tree
Since:
RFT2.1

select

public void select(Subitem pathOrIndex)
Selects a node in the tree view.

Parameters:
pathOrIndex - a Subitem (either atPath() or atList()) that indicates the position of the node in the tree
Since:
RFT2.1

isExpanded

public boolean isExpanded(Subitem pathOrIndex)
Returns a Boolean value indicating whether the specified tree node is expanded (TRUE) or collapsed (FALSE).

Parameters:
pathOrIndex - a Subitem (either atPath() or atList()) that indicates the position of the node in the tree
Returns:
true if the specified tree node is expanded or false if collapsed
Since:
RFT2.1

isSelected

public boolean isSelected(Subitem pathOrIndex)
Returns a Boolean value indicating whether the specified tree node is selected (TRUE) or not selected (FALSE).

Parameters:
pathOrIndex - a Subitem (either atPath() or atList()) that indicates the position of the node in the tree
Returns:
true if the specified tree node is selected or false otherwise
Since:
RFT2.1

isExists

public boolean isExists(Subitem pathOrIndex)
Returns a Boolean value indicating whether the specified object exists (TRUE) or does not exist (FALSE).

Parameters:
pathOrIndex - a Subitem (either atPath() or atList()) that indicates the position of the node in the tree
Returns:
true if the specified object exists. false if it doesn not exist.
Since:
RFT2.1