Main Page | File List | File Members

IeDhtml.js File Reference


Detailed Description

Implements services to interact with the DHTML model within Internet Explorer windows.

Definition in file IeDhtml.js.

Go to the source code of this file.

Functions

function IeDhtml ()

Variables

this _contains
this _sleep
this assertPageHasText
this assertSelectHasOption
this assertTagHasText
this assertTextContains
this checkRadioButton
this checkSubmit
this clickButton
this clickImage
this clickLink
this clickLinkRange
this clickObj
this clickObjById
this closeWindow
this comWin
this defaultFrame
this doc
this findButton
this findByTag
this findByTagAndAttr
this findByText
this findCheckBox
this findField
this findImage
this findLink
this findObjById
this findParent
this findRadioButton
this findRowByText
this findScope
this findSelect
this findTableCell
this findTimeout
this navigateTo
this navigateToAsyn
this openWindow
this openWindowAsync
this seekAndSetWindow
this seekWindow
this setCheckBox
this setField
this setFindScope
this setFindScopeToFrame
this setFrame
this setSelectOption
this setTime
this setWindow
this submitPause
this win


Function Documentation

function IeDhtml  ) 
 

Construct an IeDhtml object.

Definition at line 8 of file IeDhtml.js.


Variable Documentation

this _contains
 

Check whether a string contains another string.

Definition at line 759 of file IeDhtml.js.

this _sleep
 

Sleeps for given number of milliseconds.

Definition at line 31 of file IeDhtml.js.

this assertPageHasText
 

Assert that the response page's text contains given string. The optional error message will be appended the exception message in case of failure.

Definition at line 798 of file IeDhtml.js.

this assertSelectHasOption
 

Assert that a SELECT object has a OPTION object with given substring. Optional message argument will be appended to the exception message in case of failure.

Definition at line 781 of file IeDhtml.js.

this assertTagHasText
 

Assert that an element with given tag name and index contains given text

Definition at line 811 of file IeDhtml.js.

this assertTextContains
 

Assert that an element's innerText contains given text. The optional error message will be appended to the exception message in case of failure.

Definition at line 828 of file IeDhtml.js.

this checkRadioButton
 

Toggle the state of the idx-th radio box.

Definition at line 732 of file IeDhtml.js.

this checkSubmit
 

Check the submit response. This method is called internally by many methods which are expected to trigger submit operation. This method waits till the document's status becomes 'complete', then set this.doc to the document object of the default frame if the window has frames. This method uses the members submitPause and findTimeout to control the minimum and maximal waiting time.

See also:
setTime

Definition at line 615 of file IeDhtml.js.

this clickButton
 

Click on a button object whose label contains given text or whose id equals the given text. If the optional index argument is given this function returns the index-th button with given label.

Definition at line 572 of file IeDhtml.js.

this clickImage
 

Click on an image object whose src attributes contains given string. If an index argument is given, the index-th such image object will be clicked.

Definition at line 585 of file IeDhtml.js.

this clickLink
 

Click on an anchor object whose target contains specific text. If the the index argument is specified, the index-th such anchor object will be clicked.

Definition at line 547 of file IeDhtml.js.

this clickLinkRange
 

Click on a range of anchor objects whose target contains specific text as defined in argument list. Notice this method accepts variable number of arguments.

Definition at line 561 of file IeDhtml.js.

this clickObj
 

Trigger a click event on an DHTML object, then wait till the document's status becomes 'complete' which normally means that the response from the Web server has been loaded completely into the document object.

See also:
checkSubmit

Definition at line 531 of file IeDhtml.js.

this clickObjById
 

Click on an object with given id or name.

Definition at line 597 of file IeDhtml.js.

this closeWindow
 

Close the current IE window.

See also:
openWindow

seekWindow

setWindow

Definition at line 91 of file IeDhtml.js.

this comWin
 

Reference to IE COM object.

Definition at line 10 of file IeDhtml.js.

this defaultFrame
 

The index, name or id of the default frame for the doc object.

Definition at line 28 of file IeDhtml.js.

this doc
 

The underlaying DHTML document object.

Definition at line 13 of file IeDhtml.js.

this findButton
 

Find a button object whose label contains given string, or whose id equals given string. If the index parameter is given, index-th button with given label will be returned.

Definition at line 307 of file IeDhtml.js.

this findByTag
 

Find a HTML element with given tag name. If the idx argument is specified, the idx-th such element will be returned. If the tag parameter is the empty string all tags are searched.

Definition at line 454 of file IeDhtml.js.

this findByTagAndAttr
 

Find a HTML element with given tag name and attribute sub-string. If the idx argument is specified, the idx-th such element will be returned. The syntax for the attrFilter is [attrName]~[SubString]. For instance findByTagAndAttr("INPUT", "value~abc", 2) finds the 2-th INPUT object whose value contains the substring abc.

If the tag parameter is the empty string all tags are searched. If the attrFilter parameter is empty all this method just returns the idx-th object with the given tag name.

Definition at line 471 of file IeDhtml.js.

this findByText
 

Find the idx-th appearence of given text within the whole document object, then return the closest object containing the text.

Definition at line 413 of file IeDhtml.js.

this findCheckBox
 

Find an check box with given index, id or name.

Definition at line 364 of file IeDhtml.js.

this findField
 

Find an INPUT object of type text or password with given index, id or name.

Definition at line 340 of file IeDhtml.js.

this findImage
 

Find an image object whose src attribute contains given string

Definition at line 248 of file IeDhtml.js.

this findLink
 

Find an anchor object whose description contains given string. If the index paramter is present, the index-th anchor object containing given string will be returned. If the parameter str_or_reg is regular expression object, e.g. /Hello.*Word/i, the regular expression will be used to find matching text.

Definition at line 227 of file IeDhtml.js.

this findObjById
 

Find an object with given id or name. If the optional tagName and type are given, the object must have given tag name and type. If there are multiple object with the same id or name which satify the tagName and type condition, the first one found will be returned. Notice: In DHTML element id is case-incensitive.

Definition at line 269 of file IeDhtml.js.

this findParent
 

Find the first parent of given object with given tag name.

Definition at line 435 of file IeDhtml.js.

this findRadioButton
 

Find an radio box with given index, id or name.

Definition at line 381 of file IeDhtml.js.

this findRowByText
 

Finds a TR object with specific text.

Definition at line 769 of file IeDhtml.js.

this findScope
 

Search scope object for most find-operations.

Definition at line 25 of file IeDhtml.js.

this findSelect
 

Find a SELECT object with given index, id or name. If there are multiple SELECT object with the same id or name the first will be returned.

Definition at line 400 of file IeDhtml.js.

this findTableCell
 

Find a cell in a table. The table is identified by given id or index. The cell is indentified by row and column index within the table.

Definition at line 499 of file IeDhtml.js.

this findTimeout
 

Timeout value in milliseconds for find-operations.

Definition at line 22 of file IeDhtml.js.

this navigateTo
 

Navigate current IE browser to a new URL.

Definition at line 72 of file IeDhtml.js.

this navigateToAsyn
 

Navigate IE to a new URL and waits till the document's status becomes completed

Definition at line 81 of file IeDhtml.js.

this openWindow
 

Start IE and nevigate it to given URL.

See also:
closeWindow

seekWindow

setWindow

Definition at line 65 of file IeDhtml.js.

this openWindowAsync
 

Start IE and nevigate it to given URL. Don't wait for the document changes to completed status.

See also:
openWindow

Definition at line 40 of file IeDhtml.js.

this seekAndSetWindow
 

Find IE window whose title matches titlePattern and set the found window as the window object of current IeDhtml object. If the second argument is provided and is the boolean true, the first matching window will be set, otherwise the last one.

Definition at line 138 of file IeDhtml.js.

this seekWindow
 

Seek a window with given pattern in its titles. If there more than one such windows, the last one will be returned, unless returnFirst is set to true in which case the first window found will be returned.

Together with method setWindow() you can attach an IeDhtml to any open Internet Explorer window.

See also:
setWindow

Definition at line 110 of file IeDhtml.js.

this setCheckBox
 

Set the state of the idx-th CHECKBOX object to checked which must be a boolean value.

Definition at line 720 of file IeDhtml.js.

this setField
 

Set the value of an text input object.

Definition at line 742 of file IeDhtml.js.

this setFindScope
 

Set the find scope to a DHTML object. The default find scope is the whole document object of the default frame. Using this method we can restrict the searching scopes. Most find operations search within the find scope.

Definition at line 209 of file IeDhtml.js.

this setFindScopeToFrame
 

Set the find scope to the document object of frame with give index.

Definition at line 169 of file IeDhtml.js.

this setFrame
 

Change the default frame index for window with frames. After each submit action, the document object of the frame with the default index/id/name will become the default document object this.doc. The argument may be the index, the name or the id of a frame. If the frames are nested throught multiple document the argument must be a string of syntax "idx_or_id1/idx_or_id2/...".

See also:
setFindScopeToFrame

Definition at line 158 of file IeDhtml.js.

this setSelectOption
 

Select an option of a SELELT element. The argument idx_or_id is either the index or the id of the SELECT object. opt_str_or_idx is a substring the option or the index of the option.

Definition at line 688 of file IeDhtml.js.

this setTime
 

Set the timeout values. 'pause' specifies the minimum time in milliseconds a submit action will wait before returning. 'timeout' specifies the maximum time in milliseconds that a find operation will wait for completion. If no object can be found, an exception will normally be thrown.

Definition at line 193 of file IeDhtml.js.

this setWindow
 

Set given IE window object as current window object of this IeDhtml object.

Definition at line 180 of file IeDhtml.js.

this submitPause
 

The pause in milliseconds after submission.

Definition at line 19 of file IeDhtml.js.

this win
 

Reference to document's window object.

Definition at line 16 of file IeDhtml.js.


Generated on Thu Sep 29 09:05:40 2005 for IeUnit by  doxygen 1.3.9.1