Window handles (getWindowHandles) in Selenium Java

Introduction

Window handles help you switch between different browser windows or tabs during a test. This lets you control and test multiple windows easily.

When your test opens a new browser tab or window and you need to switch to it.

When you want to verify content in a popup window.

When you need to close one window and continue testing in another.

When testing multi-window workflows like login popups or external links.

When automating scenarios that involve multiple browser windows.

Syntax

Selenium Java

Set<String> windowHandles = driver.getWindowHandles();

getWindowHandles() returns a set of unique IDs for all open windows.

You can use these IDs to switch control between windows using driver.switchTo().window(handle).

Examples

This prints all window handles currently open.

Selenium Java

Set<String> handles = driver.getWindowHandles();
for (String handle : handles) {
    System.out.println(handle);
}

This switches to the new window that is not the main one.

Selenium Java

String mainWindow = driver.getWindowHandle();
Set<String> allWindows = driver.getWindowHandles();
for (String window : allWindows) {
    if (!window.equals(mainWindow)) {
        driver.switchTo().window(window);
        break;
    }
}

Sample Program

This test opens a website, then opens a new tab with Google. It gets all window handles, switches to the new tab, and prints its title.

Selenium Java

import org.openqa.selenium.WebDriver;
import org.openqa.selenium.chrome.ChromeDriver;
import java.util.Set;

public class WindowHandlesExample {
    public static void main(String[] args) throws InterruptedException {
        System.setProperty("webdriver.chrome.driver", "path/to/chromedriver");
        WebDriver driver = new ChromeDriver();

        driver.get("https://www.example.com");
        String mainWindow = driver.getWindowHandle();

        // Simulate opening a new window (for example purposes, open a new URL in new tab)
        ((org.openqa.selenium.JavascriptExecutor) driver).executeScript("window.open('https://www.google.com','_blank');");

        Set<String> allWindows = driver.getWindowHandles();
        System.out.println("Number of windows: " + allWindows.size());

        for (String window : allWindows) {
            if (!window.equals(mainWindow)) {
                driver.switchTo().window(window);
                System.out.println("Switched to new window with title: " + driver.getTitle());
                break;
            }
        }

        driver.quit();
    }
}

Important Notes

Always store the main window handle before opening new windows to switch back later.

Window handles are unique strings identifying each open window or tab.

Use driver.switchTo().window(handle) to change focus to a specific window.

Summary

Window handles let you manage multiple browser windows or tabs in Selenium tests.

getWindowHandles() returns all open window IDs as a set.

Switch between windows using their handles to test multi-window scenarios.

Practice

1. What does the Selenium method getWindowHandles() return when called?

easy

A. A set of all open window handles (IDs) in the current WebDriver session

B. The handle of the current active window only

C. The title of the current browser window

D. The URL of the current page

Solution

1. Step 1: Understand the purpose of getWindowHandles()

   This method is designed to return all window handles for every open window or tab in the current browser session.

2. Step 2: Identify the return type

   The method returns a Set of Strings, each representing a unique window handle (ID).

3. Final Answer:

   A set of all open window handles (IDs) in the current WebDriver session -> Option A

4. Quick Check:

   getWindowHandles() = all window IDs [OK]

Hint: Remember: getWindowHandles() returns all window IDs as a set [OK]

Common Mistakes:

• Confusing getWindowHandles() with getWindowHandle() which returns one handle
• Expecting a list or array instead of a set
• Thinking it returns page titles or URLs

2. Which of the following is the correct syntax to get all window handles in Selenium Java?

easy

A. List<String> handles = driver.getWindowHandles();

B. String handles = driver.getWindowHandles();

C. Set<String> handles = driver.getWindowHandles();

D. Set handles = driver.getWindowHandle();

Solution

1. Step 1: Check the return type of getWindowHandles()

   The method returns a Set of Strings, so the variable must be declared as Set<String>.

2. Step 2: Verify method name and syntax

   The correct method is getWindowHandles() (plural), and it belongs to the WebDriver instance named driver.

3. Final Answer:

   Set<String> handles = driver.getWindowHandles(); -> Option C

4. Quick Check:

   Correct syntax uses Set<String> and getWindowHandles() [OK]

Hint: Use Set<String> for getWindowHandles() return type [OK]

Common Mistakes:

• Using List instead of Set for window handles
• Calling getWindowHandle() instead of getWindowHandles()
• Assigning to a String instead of a collection

3. Consider the following code snippet:

Set<String> handles = driver.getWindowHandles();
System.out.println(handles.size());

If the browser has 3 tabs open, what will be printed?

medium

A. An exception is thrown

B. 1

C. 0

D. 3

Solution

1. Step 1: Understand what getWindowHandles() returns

   It returns a set containing all window handles for every open tab or window.

2. Step 2: Determine the size of the set

   Since there are 3 tabs open, the set will contain 3 unique handles, so size() returns 3.

3. Final Answer:

   3 -> Option D

4. Quick Check:

   Number of tabs = size of handles set = 3 [OK]

Hint: Size of getWindowHandles() set equals number of open tabs/windows [OK]

Common Mistakes:

• Assuming size() returns 1 for current window only
• Expecting an exception if multiple tabs exist
• Confusing getWindowHandles() with getWindowHandle()

4. You wrote this code to switch to a new window:

Set<String> handles = driver.getWindowHandles();
String newWindow = handles.iterator().next();
driver.switchTo().window(newWindow);

But it always switches to the original window. What is the likely problem?

medium

A. getWindowHandles() returns an empty set

B. Using iterator().next() returns the first handle, which is the original window

C. switchTo().window() requires window title, not handle

D. You must convert the set to a list before switching

Solution

1. Step 1: Analyze iterator().next() behavior on a Set

   Calling iterator().next() on a Set returns the first element, which is usually the original window handle.

2. Step 2: Understand why it switches to original window

   Since newWindow is assigned the original window handle, switching to it does not change the window.

3. Final Answer:

   Using iterator().next() returns the first handle, which is the original window -> Option B

4. Quick Check:

   iterator().next() = first handle (original window) [OK]

Hint: iterator().next() returns first handle, often original window [OK]

Common Mistakes:

• Assuming iterator().next() gives the new window handle
• Thinking switchTo().window() needs window title
• Not checking if getWindowHandles() is empty

5. You want to switch to a newly opened window different from the original one. Given String originalHandle = driver.getWindowHandle(); and Set<String> allHandles = driver.getWindowHandles();, which code correctly switches to the new window?

hard

A. for (String handle : allHandles) { if (!handle.equals(originalHandle)) { driver.switchTo().window(handle); break; } }

B. driver.switchTo().window(allHandles.iterator().next());

C. driver.switchTo().window(originalHandle);

D. driver.switchTo().window(allHandles.toArray()[0].toString());

Solution

1. Step 1: Identify the original window handle

   We have the original window handle stored in originalHandle.

2. Step 2: Loop through all handles to find the new one

   Iterate over all handles and switch to the one that is not equal to the original handle.

3. Step 3: Switch to the new window

   Once found, call driver.switchTo().window(handle) and break the loop.

4. Final Answer:

   for (String handle : allHandles) { if (!handle.equals(originalHandle)) { driver.switchTo().window(handle); break; } } -> Option A

5. Quick Check:

   Switch to handle != originalHandle [OK]

Hint: Loop handles, skip original, switch to new [OK]

Common Mistakes:

• Switching to first handle without checking if it's original
• Using toArray()[0] which may be original window
• Switching to originalHandle instead of new window