lib/src/target_locator.dart

// Copyright (c) 2015, the Dart project authors.  Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

part of webdriver;

class TargetLocator extends _WebDriverBase {
  TargetLocator._(driver) : super(driver, '');

  /**
   * Change focus to another frame on the page.
   *
   * If [frame] is a:
   *   int: select by its zero-based index
   *   String: select frame by the name of the frame window or the id of the
   *           frame or iframe tag.
   *   WebElement: select the frrame for a previously found frame or iframe
   *               element.
   *   not provided: selects the first frame on the page or the main document.
   *
   * Throws [WebDriverError] no such frame if the specified frame can't be
   * found.
   */
  Future frame([frame]) async {
    await _post('frame', {'id': frame});
  }

  /**
   * Switch the focus of future commands for this driver to the window with the
   * given name/handle.
   *
   * Throws [WebDriverError] no such window if the specified window can't be
   * found.
   */
  Future window(dynamic window) async {
    if (window is Window) {
      await _post('window', {'name': window.handle});
    } else if (window is String) {
      await _post('window', {'name': window});
    } else {
      throw 'Unsupported type: ${window.runtimeType}';
    }
  }

  /**
   * Switches to the currently active modal dialog for this particular driver
   * instance.
   *
   * Throws WebDriverEror no alert present if there is not currently an alert.
   */
  Future<Alert> get alert async {
    var text = await _get('alert_text');
    return new Alert._(text, driver);
  }

  @override
  String toString() => '$driver.switchTo';

  @override
  int get hashCode => driver.hashCode;

  @override
  bool operator ==(other) => other is TargetLocator && other.driver == driver;
}