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

Project Version 2.0

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

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.FrameTestObject
              extended bycom.rational.test.ft.object.interfaces.TopLevelTestObject
                  extended bycom.rational.test.ft.object.interfaces.BrowserTestObject
All Implemented Interfaces:
IBrowserObject, IFrame, IGraphical, ITopWindow

public class BrowserTestObject
extends TopLevelTestObject
implements IBrowserObject

Provides script access to the general browser, which is the HTML Browser TestObject class.

Since:
RFT1.0

Field Summary
 
Fields inherited from interface com.rational.test.ft.object.interfaces.ITopWindow
INPUTCHARS_METHOD, INPUTKEYS_METHOD
 
Constructor Summary
BrowserTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject)
          For internal use.
BrowserTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor)
          For internal use.
BrowserTestObject(com.rational.test.ft.object.map.SpyMappedTestObject mappedObject, TestObject anchor, long scriptCommandFlags)
          For internal use.
BrowserTestObject(TestObject obj)
          Constructs one TestObject from another.
BrowserTestObject(com.rational.test.ft.object.TestObjectReference ref)
          For internal use.
 
Method Summary
 boolean back()
          Navigates the browser back to the previous page.
 void deleteCookies()
          Deletes all of the browser's cookies for the current profile/user.
 void deleteCookies(java.lang.String cookie, boolean recursive)
          Deletes browser cookies specified by the path in cookie for the current profile/user.
 boolean forward()
          Navigates the browser forward to the next page.
 boolean home()
          Navigates the browser to the default home page.
 boolean loadUrl(java.lang.String url)
          Loads the given URL into the browser.
 boolean loadUrl(java.lang.String url, java.lang.String target)
          Loads the given URL into the browser.
 
Methods inherited from class com.rational.test.ft.object.interfaces.TopLevelTestObject
activate, clickDisabled, close, inputChars, inputKeys, isIconified, maximize, minimize, move, resize, restore
 
Methods inherited from class com.rational.test.ft.object.interfaces.FrameTestObject
contextHelp
 
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.IFrame
contextHelp
 
Methods inherited from interface com.rational.test.ft.object.interfaces.IGraphical
click, click, click, click, doubleClick, doubleClick, doubleClick, doubleClick, drag, drag, drag, drag, dragToScreenPoint, dragToScreenPoint, dragToScreenPoint, getChildAtPoint, getClippedScreenRectangle, getScreenPoint, getScreenPoint, getScreenRectangle, hasFocus, hover, hover, hover, hover, isEnabled, isOpaque, isPointInObject, isShowing, mouseMove, mouseMove, nClick, nClickDrag, nClickDragToScreenPoint
 

Constructor Detail

BrowserTestObject

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

Since:
RFT1.0

BrowserTestObject

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

Since:
RFT1.0

BrowserTestObject

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

Since:
RFT1.0

BrowserTestObject

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

Since:
RFT1.0

BrowserTestObject

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

Since:
RFT1.0
Method Detail

back

public boolean back()
Description copied from interface: IBrowserObject
Navigates the browser back to the previous page. This is the same as clicking the back button in the browser.

Specified by:
back in interface IBrowserObject
Returns:
true when the navigation starts; false when there is no previous page.

forward

public boolean forward()
Description copied from interface: IBrowserObject
Navigates the browser forward to the next page. This is the same as clicking the forward button in the browser.

Specified by:
forward in interface IBrowserObject
Returns:
true when the navigation starts; false when there is no previous page.

home

public boolean home()
Description copied from interface: IBrowserObject
Navigates the browser to the default home page. Note that this depends on the configuration of the given browser.

Specified by:
home in interface IBrowserObject
Returns:
true when the navigation starts; false when there is no home page defined for this browser.

loadUrl

public boolean loadUrl(java.lang.String url,
                       java.lang.String target)
Description copied from interface: IBrowserObject
Loads the given URL into the browser. The page is loaded into the frame identified by the target.

Specified by:
loadUrl in interface IBrowserObject
Parameters:
url - URL-identified page to load into browser
target - name of frame where the page is loaded
Returns:
true when the page load starts; false if the page does not load.

loadUrl

public boolean loadUrl(java.lang.String url)
Description copied from interface: IBrowserObject
Loads the given URL into the browser.

Specified by:
loadUrl in interface IBrowserObject
Parameters:
url - URL-identified page to load into browser
Returns:
true when the page load starts; false if the page does not load.

deleteCookies

public void deleteCookies()
Description copied from interface: IBrowserObject
Deletes all of the browser's cookies for the current profile/user.

Specified by:
deleteCookies in interface IBrowserObject

deleteCookies

public void deleteCookies(java.lang.String cookie,
                          boolean recursive)
Description copied from interface: IBrowserObject
Deletes browser cookies specified by the path in cookie for the current profile/user. There is an option to perform a recursive delete.

Specified by:
deleteCookies in interface IBrowserObject
Parameters:
cookie - The full path of the cookie. This is usually the domain followed by the directory path in which the intended document resides, for example, http://a.com.
recursive - If set, all cookies that are children of the path specified in cookie are deleted, for example, a.com/b/.