com.redhat.darcy.webdriver.locators.ByPartialVisibleText Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of darcy-webdriver Show documentation

An implementation of darcy and darcy-web that uses Selenium WebDriver as the automation library backend.

The newest version!

/*
 Copyright 2014 Red Hat, Inc. and/or its affiliates.

 This file is part of darcy-webdriver.

 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program.  If not, see .
 */

package com.redhat.darcy.webdriver.locators;

import org.openqa.selenium.By;
import org.openqa.selenium.SearchContext;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.internal.FindsByXPath;

import java.util.List;

/**
 * {@link By} implementation that finds elements based on whether or not their
 * text node partially matches some text.
 * 
 * @author ahenning
 */
public class ByPartialVisibleText extends By {
    private final String text;
    
    public static By ignoringCase(String text) {
        return new ByPartialVisibleTextIgnoreCase(text);
    }
    
    public ByPartialVisibleText(String text) {
        this.text = text;
    }

    @Override
    public List findElements(SearchContext context) {
        return ((FindsByXPath) context).findElementsByXPath(".//*["
                + textContains(text) + "]");
    }

    @Override
    public WebElement findElement(SearchContext context) {
        return ((FindsByXPath) context).findElementByXPath(".//*["
                + textContains(text) + "]");
    }
    
    @Override
    public int hashCode() {
        return toString().hashCode();
    }
    
    @Override
    public String toString() {
        return "ByPartialVisibleText: " + text;
    }
    
    /**
     * Generates a partial XPath expression that matches an element whose text
     * node contains some text.
     * 
     * @param attribute name
     * @param text name
     * @return String Partial XPath expression
     */
    private String textContains(String text) {
        return "contains(text(),'" + text + "')";
    }
}