com.googlecode.fightinglayoutbugs.LayoutBugDetector Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fighting-layout-bugs Show documentation

A library for automatic detection of layout bugs in web pages

There is a newer version: 0.6

/*
 * Copyright 2009-2011 Michael Tamm
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.googlecode.fightinglayoutbugs;

import com.thoughtworks.selenium.Selenium;
import org.openqa.selenium.WebDriver;

import java.io.File;
import java.util.Collection;

/**
 * @author Michael Tamm
 */
public interface LayoutBugDetector {

    /**
     * Call this method before you call {@code findLayoutBugsIn} if you
     * want to specify where screenshots of detected layout bugs should
     * be stored.
     *
     * @param screenshotDir if {@code null}, no screenshots will be stored
     */
    void setScreenshotDir(File screenshotDir);

    /**
     * Finds layout bugs in the web page currently displayed in the browser
     * controlled by the given {@link Selenium}.
     */
    Collection findLayoutBugsIn(Selenium selenium);

    /**
     * Finds layout bugs in the web page currently displayed in the browser
     * controlled by the given {@link WebDriver}.
     */
    Collection findLayoutBugsIn(WebDriver driver);

    /**
     * Finds layout bugs in the given web page.
     */
    Collection findLayoutBugsIn(WebPage webPage);
}