R/window.R

In rstudio/webdriver: 'WebDriver' Client for 'PhantomJS'

#' A browser window
#'
#' @section Usage:
#' \preformatted{w <- s$getWindow()
#' wlist <- s$getAllWindows()
#'
#' w$close()
#' w$isActive()
#' w$switchTo()
#' w$maximize()
#' w$getSize()
#' w$setSize(width, height)
#' w$getPosition()
#' w$setPosition(x, y)
#' }
#'
#' @section Arguments:
#' \describe{
#'   \item{s}{A \code{\link{Session}} object.}
#'   \item{w}{A \code{Window} object.}
#'   \item{wlist}{A list of \code{Window} objects.}
#'   \item{width}{Integer scalar, requested width of the window.}
#'   \item{height}{Integer scalar, requested height of the window.}
#'   \item{x}{Integer scalar, requested horizontal window position.}
#'   \item{y}{Integer scalar, requested vertical window position.}
#' }
#'
#' @section Details:
#'
#' The \code{getWindow} method of a \code{\link{Session}} object
#' returns the current browser window as a \code{Window} object.
#' The \code{getAllWindows} method returns a list of window objects,
#' all browser windows.
#'
#' \code{w$close()} closes the window.
#'
#' \code{w$isActive()} returns \code{TRUE} if the window is active,
#' \code{FALSE} otherwise.
#'
#' \code{w$switchTo} makes the window active.
#'
#' \code{w$maximize} maximizes the window. Currently it sets it to
#' a fixed size.
#'
#' \code{w$getSize} returns the size of the window, in a list with
#' elementh \code{width} and \code{height}, both integers.
#'
#' \code{w$setSize} sets the size of the window.
#'
#' \code{w$getPosition} returns the position of the window on the
#' screen. Phantom.js being headless, it always returns
#' \code{list(x = 0, y = 0)}, and it is included to have a complete
#' impelementation of the WebDriver standard.
#'
#' \code{w$setPosition(x, y)} sets the position of the window on the
#' screen. Phantom.js being headless, it has no effect, and it is included
#' to have a complete implementation of the WebDriver standard.
#'
#' @name Window
#' @importFrom R6 R6Class
NULL

Window <- R6Class(
  "Window",
  public = list(

    initialize = function(id, session, session_private) {
      window_initialize(self, private, id, session, session_private)
    },

    close = function()
      window_close(self, private),

    isActive = function()
      window_isActive(self, private),

    switchTo = function()
      window_switchTo(self, private),

    ## Not supported
    ## make_fullscreen = function()
    ##   window_make_fullscreen(self, private),

    maximize = function()
      window_maximize(self, private),

    getSize = function()
      window_getSize(self, private),

    setSize = function(width, height)
      window_setSize(self, private, width, height),

    getPosition = function()
      window_getPosition(self, private),

    setPosition = function(x, y)
      window_setPosition(self, private, x, y)
  ),
  private = list(
    id = NULL,
    session = NULL,
    session_private = NULL
  )
)

window_initialize <- function(self, private, id, session,
                              session_private) {

  assert_string(id)
  assert_session(session)

  private$id <- id
  private$session <- session
  private$session_private <- session_private

  invisible(self)

}

window_close <- function(self, private) {

  "!DEBUG window_close"
  private$session_private$makeRequest(
    "CLOSE WINDOW",
    list(name = private$id)
  )

  invisible(self)
}

window_isActive <- function(self, private) {

  "!DEBUG window_isActive"
  active <- private$session$getWindow()
  active$.__enclos_env__$private$id == private$id
}

window_switchTo <- function(self, private) {

  "!DEBUG window_switchTo"
  private$session_private$makeRequest(
    "SWITCH TO WINDOW",
    list(name = private$id)
  )

  invisible(self)
}

## window_make_fullscreen <- function(self, private) {

##  "!DEBUG window_make_fullscreen"
##   private$session_private$makeRequest(
##     "FULLSCREEN WINDOW",
##   )

##   invisible(self)
## }

window_maximize <- function(self, private) {

  "!DEBUG window_maximize"
  private$session_private$makeRequest(
    "MAXIMIZE WINDOW",
    params = list(window_id = private$id)
  )

  invisible(self)
}

window_getSize <- function(self, private) {

  "!DEBUG window_getSize"
  response <- private$session_private$makeRequest(
    "GET WINDOW SIZE",
    params = list(window_id = private$id)
  )

  list(width = response$value$width, height = response$value$height)
}

window_setSize <- function(self, private, width, height) {

  "!DEBUG window_setSize `width`x`height`"
  assert_window_size(width)
  assert_window_size(height)

  private$session_private$makeRequest(
    "SET WINDOW SIZE",
    list(
      width = width,
      height = height
    ),
    params = list(window_id = private$id)
  )

  invisible(self)
}

window_getPosition <- function(self, private) {

  "!DEBUG window_getPosition"
  response <- private$session_private$makeRequest(
    "GET WINDOW POSITION",
    params = list(window_id = private$id)
  )

  response$value
}

window_setPosition <- function(self, private, x, y) {

  "!DEBUG window_setPosition"
  assert_window_position(x)
  assert_window_position(y)

  private$session_private$makeRequest(
    "SET WINDOW POSITION",
    list(
      x = x,
      y = y
    ),
    params = list(window_id = private$id)
  )


  invisible(self)
}