com.googlecode.fightinglayoutbugs.TextDetector 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

The newest version!

/*
 * Copyright 2009-2012 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;

/**
 * Detects those pixels, which belong to
 * textual content in a web page.
 */
public interface TextDetector {

    /**
     * Call this method to configure the text detector in such a way, that all rectangle
     * regions of the analyzed web page covered by those elements, which are selected
     * by the given jQuery selector, will be ignored when text pixels are detected.
     */
    void ignore(String jQuerySelector);

    /**
     * Returns a two dimensional array a, whereby a[x][y] is true
     * if the pixel with the coordinates x,y in a {@link WebPage#getScreenshot screenshot} of the
     * given web page belongs to displayed text, otherwise a[x][y] is false.
     */
    boolean[][] detectTextPixelsIn(WebPage webPage);

}