com.paypal.selion.platform.mobile.ios.UIANavigationBar Maven / Gradle / Ivy

Go to download
/*-------------------------------------------------------------------------------------------------------------------*\
|  Copyright (C) 2015 PayPal                                                                                          |
|                                                                                                                     |
|  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.paypal.selion.platform.mobile.ios;

import java.util.List;
import java.util.ListIterator;

import org.openqa.selenium.By;
import org.openqa.selenium.WebElement;

import com.paypal.selion.logger.SeLionLogger;
import com.paypal.selion.platform.mobile.UIOperationFailedException;
import com.paypal.test.utilities.logging.SimpleLogger;

/**
 * The UIANavigationBar class allows access to, and control of, buttons in your app’s navigation bar.
 */
public class UIANavigationBar extends UIAElement implements UIAutomationNavigationBar {

    private static final SimpleLogger logger = SeLionLogger.getLogger();

    private static final String BACK = "Back";

    private static final String LABEL = "label";

    private static final String NAME = "name";

    private static final String UIABUTTON = "UIAButton";

    public UIANavigationBar(String locator) {
        super(locator);
    }

    @Override
    public void clickLeftButton(Object... expected) {
        logger.entering();
        WebElement navigationBarElement = findElement(this.getLocator());
        List buttonElements = navigationBarElement.findElements(By.className(UIABUTTON));
        WebElement leftButton = findLeftButton(buttonElements);
        getBridgeDriver().tap(leftButton);
        if (expected != null && expected.length > 0) {
            waitFor(expected);
        }
        logger.exiting();
    }

    @Override
    public void clickRightButton(Object... expected) {
        logger.entering();
        WebElement navigationBarElement = findElement(this.getLocator());
        List buttonElements = navigationBarElement.findElements(By.className(UIABUTTON));
        WebElement rightButton = findRightButton(buttonElements);
        getBridgeDriver().tap(rightButton);
        if (expected != null && expected.length > 0) {
            waitFor(expected);
        }
        logger.exiting();
    }

    private WebElement findLeftButton(List buttonElements) {
        if (buttonElements.size() >= 1) {
            for (WebElement button : buttonElements) {
                if (BACK.equals(button.getAttribute(LABEL)) || BACK.equals(button.getAttribute(NAME))) {
                    return button;
                }
            }

            /*
             * Assumption that 'if the default left button with the label "BACK" is not present in the iOS app, consider
             * the button in the first index to be back button'. Tests on a normal iOS app shows that a
             * WebDriverException is thrown if the button at the first index of a navigation bar in the first screen is
             * operated.
             */
            return buttonElements.get(0);
        }
        throw new UIOperationFailedException("UIANavigationBar does not have any left button");
    }

    private WebElement findRightButton(List buttonElements) {
        if (buttonElements.size() >= 1) {
            
            /*
             * Assumption that 'right navigation button is seated on an index greater than 0'
             */
            int index = buttonElements.size() - 1;
            ListIterator listIterator = buttonElements.listIterator(buttonElements.size());
            while (listIterator.hasPrevious()) {
                WebElement button = listIterator.previous();
                if (!BACK.equals(button.getAttribute(LABEL)) && !BACK.equals(button.getAttribute(NAME)) && index > 0) {
                    return button;
                }
                --index;
            }
        }
        throw new UIOperationFailedException("UIANavigationBar does not have any right button");
    }

}