class WebDriver.TargetLocator

An interface for changing the focus of the driver to another frame or window.

new WebDriver.TargetLocator(driver)

Parameters
driverwebdriver.WebDriver

The parent driver.

Instance Methods

activeElement()code »

Schedules a command retrieve the document.activeElement element on the current document, or document.body if activeElement is not available.

Returns
webdriver.WebElementPromise

The active element.


alert()code »

Schedules a command to change focus to the active alert dialog. This command will return a bot.ErrorCode.NO_SUCH_ALERT error if an alert dialog is not currently open.

Returns
webdriver.AlertPromise

The open alert.


defaultContent()code »

Schedules a command to switch focus of all future commands to the first frame on the page.

Returns
webdriver.promise.Promise<undefined>

A promise that will be resolved when the driver has changed focus to the default content.


frame(nameOrIndex)code »

Schedules a command to switch the focus of all future commands to another frame on the page.

If the frame is specified by a number, the command will switch to the frame by its (zero-based) index into window.frames.

If the frame is specified by a string, the command will select the frame by its name or ID. To select sub-frames, simply separate the frame names/IDs by dots. As an example, "main.child" will select the frame with the name "main" and then its child "child".

If the specified frame can not be found, the deferred result will errback with a bot.ErrorCode.NO_SUCH_FRAME error.

Parameters
nameOrIndex(string|number)

The frame locator.

Returns
webdriver.promise.Promise<undefined>

A promise that will be resolved when the driver has changed focus to the specified frame.


window(nameOrHandle)code »

Schedules a command to switch the focus of all future commands to another window. Windows may be specified by their window.name attribute or by its handle (as returned by webdriver.WebDriver#getWindowHandles).

If the specificed window can not be found, the deferred result will errback with a bot.ErrorCode.NO_SUCH_WINDOW error.

Parameters
nameOrHandlestring

The name or window handle of the window to switch focus to.

Returns
webdriver.promise.Promise<undefined>

A promise that will be resolved when the driver has changed focus to the specified window.