org.nvonop.selenium.framework.controls.Frame.java Source code

Introduction

Here is the source code for org.nvonop.selenium.framework.controls.Frame.java

Source

/*
The MIT License (MIT)
    
Copyright (c) 2015 Nicholas Oppersdorff
    
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
    
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
    
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
 */

package org.nvonop.selenium.framework.controls;

import org.openqa.selenium.By;
import org.openqa.selenium.WebDriver;

import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * This class comprises of functionality that would be used when interacting
 * with a typical frame within a page.
 *
 * @author nvonop
 */
public class Frame extends BaseControl {

    private static final Logger LOGGER = Logger.getLogger(Frame.class.getName());

    /**
     * Constructor that takes a WebDriver object and By object. These are then
     * set in the base class.
     *
     * @param driver
     * @param locator
     */
    public Frame(WebDriver driver, By locator) {
        this.driver = driver;
        setLocator(locator);
    }

    private static String getLocatorString(By locator) {
        String[] locatorArray = locator.toString().split("\\s");
        String locatorSubString = locatorArray[1];
        LOGGER.log(Level.FINEST, "Parsing locator: " + locator.toString());
        LOGGER.log(Level.FINEST, "Locator String: " + locatorArray[1]);

        return locatorSubString;
    }

    /**
     * This method enables focus to switch to the frame when it is called.
     */
    public void switchToFrame() {
        String locatorSubString = getLocatorString(getLocator());

        driver.switchTo().frame(locatorSubString);
    }
}