org.jboss.arquillian.ajocado.waiting.conditions.StyleEquals Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of graphene-selenium-impl Show documentation
Testing Ajax with flavour of sexy type-safe API
There is a newer version: 2.0.0.Alpha5
Show newest version
/**
 * JBoss, Home of Professional Open Source
 * Copyright 2011, Red Hat, Inc. and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.jboss.arquillian.ajocado.waiting.conditions;

import static org.apache.commons.lang3.StringEscapeUtils.escapeEcmaScript;
import static org.jboss.arquillian.ajocado.javascript.JavaScript.js;

import org.jboss.arquillian.ajocado.css.CssProperty;
import org.jboss.arquillian.ajocado.framework.GrapheneSelenium;
import org.jboss.arquillian.ajocado.framework.GrapheneSeleniumContext;
import org.jboss.arquillian.ajocado.javascript.JavaScript;
import org.jboss.arquillian.ajocado.locator.element.ElementLocator;
import org.jboss.arquillian.ajocado.waiting.ajax.JavaScriptCondition;
import org.jboss.arquillian.ajocado.waiting.selenium.SeleniumCondition;
import org.jboss.arquillian.core.spi.Validate;

/**
 *
 * 
 * Implementation of Condition for waiting if element given by elementLocator has given CSS style property's value equal to
 * given value.
 * 
 *
 * 
 * Implements Condition and JavaScriptCondition used in SeleniumWaiting and AjaxWaiting.
 * 
 *
 * @author Lukas Fryc
 * @version $Revision$
 */
public class StyleEquals implements SeleniumCondition, JavaScriptCondition {

    /**
     * Proxy to local selenium instance
     */
    private GrapheneSelenium selenium = GrapheneSeleniumContext.getProxy();

    /** The element locator. */
    private ElementLocator elementLocator;

    /** The CSS property. */
    private CssProperty cssProperty;

    /**
     * The value
     */
    private String value;

    /**
     * Instantiates a new text equals.
     */
    protected StyleEquals() {
    }

    /*
     * (non-Javadoc)
     *
     * @see org.jboss.arquillian.ajocado.waiting.Condition#isTrue()
     */
    @Override
    public boolean isTrue() {
        validate();
        return selenium.getStyle(elementLocator, cssProperty).equals(value);
    }

    /*
     * (non-Javadoc)
     *
     * @see org.jboss.arquillian.ajocado.waiting.ajax.JavaScriptCondition#getJavaScriptCondition()
     */
    @Override
    public JavaScript getJavaScriptCondition() {
        validate();
        String escapedLocator = escapeEcmaScript(this.elementLocator.inSeleniumRepresentation());
        String escapedCssProperty = escapeEcmaScript(this.cssProperty.getPropertyName());
        String escapedText = escapeEcmaScript(this.value);
        return js("selenium.isElementPresent('{0}') && (selenium.getStyle('{0}', '{1}') == '{2}')").parametrize(escapedLocator,
                escapedCssProperty, escapedText);
    }

    private void validate() {
        Validate.notNull(elementLocator, "elementLocator should not be null");
        Validate.notNull(cssProperty, "cssProperty should not be null");
        Validate.notNull(value, "value should not be null");
    }

    /**
     * Factory method.
     *
     * @return single instance of TextEquals
     */
    public static StyleEquals getInstance() {
        return new StyleEquals();
    }

    /**
     * 
     * Returns the StyleEquals instance with given elementLocator set.
     * 
     *
     * 
     * From this locator will be obtained the CSS property.
     * 
     *
     * @param elementLocator the element locator
     * @return the StyleEquals object with preset locator
     */
    public StyleEquals locator(ElementLocator elementLocator) {
        Validate.notNull(elementLocator, "elementLocator should not be null");

        StyleEquals copy = copy();
        copy.elementLocator = elementLocator;

        return copy;
    }

    /**
     * 
     * Returns the StyleEquals instance with CSS property preset.
     * 
     *
     * 
     * This CSS property will be obtained in way to compare equality to given value.
     * 
     *
     * @param cssProperty the property to obtain
     * @return the StyleEquals object with preset CSS property to obtain
     */
    public StyleEquals property(CssProperty cssProperty) {
        Validate.notNull(cssProperty, "cssProperty should not be null");

        StyleEquals copy = copy();
        copy.cssProperty = cssProperty;

        return copy;
    }

    /**
     * 
     * Returns the StyleEquals instance with value set.
     * 
     *
     * 
     * For equality with this value the condition will wait.
     * 
     *
     * @param value it should wait for equality
     * @return the StyleEquals object with preset value
     */
    public StyleEquals value(String value) {
        Validate.notNull(value, "value should not be null");

        StyleEquals copy = copy();
        copy.value = value;

        return copy;
    }

    /**
     * Returns the exact copy of this ElementPresent object.
     *
     * @return the copy of this TextEquals object
     */
    private StyleEquals copy() {
        StyleEquals copy = new StyleEquals();
        copy.elementLocator = elementLocator;
        copy.cssProperty = cssProperty;
        copy.value = value;
        return copy;
    }
}